{
"components": {
"schemas": {
"APIKeyBasic": {
"properties": {
"apiKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"counter": {
"type": "integer"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"ipRange": {
"items": {
"description": "A network address",
"example": "192.0.2.0/24",
"title": "IPNetAddress",
"type": "string"
},
"type": "array"
},
"isActive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"scope": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "APIKeyBasic",
"type": "object"
},
"APIKeyModifiedIPRangeAdded": {
"properties": {
"ipRangeAdded": {
"$ref": "#/components/schemas/ArraySchema_3732626131"
}
},
"title": "APIKeyModifiedIPRangeAdded",
"type": "object"
},
"APIKeyModifiedIPRangeRemoved": {
"properties": {
"ipRangeRemoved": {
"$ref": "#/components/schemas/ArraySchema_6331323166"
}
},
"title": "APIKeyModifiedIPRangeRemoved",
"type": "object"
},
"APIKeyModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "APIKeyModifiedIsActive",
"type": "object"
},
"APIKeyModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "APIKeyModifiedName",
"type": "object"
},
"APIKeyModifiedScopeID": {
"properties": {
"newScopeID": {
"description": "The new scopeid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldScopeID": {
"description": "The old scopeid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "APIKeyModifiedScopeID",
"type": "object"
},
"APIKeyModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserID": {
"description": "The old userid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "APIKeyModifiedUserID",
"type": "object"
},
"AllowDirectLinks": {
"properties": {
"custom": {
"type": "boolean"
},
"original": {
"type": "boolean"
},
"preview": {
"type": "boolean"
}
},
"title": "AllowDirectLinks",
"type": "object"
},
"ArrayOfCollectionDeleteObject": {
"description": "An array of: CollectionDeleteObject",
"example": [
{
"error": "",
"id": 5
}
],
"items": {
"$ref": "#/components/schemas/CollectionDeleteObject"
},
"title": "ArrayOfCollectionDeleteObject",
"type": "array"
},
"ArrayOfEmailLanguage": {
"description": "Adds email addresses authorized to use the upload link.",
"example": [
{
"email": "technik@pixx.io",
"language": "de"
}
],
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"title": "ArrayOfEmailLanguage",
"type": "array"
},
"ArrayOfEmailLanguage_3634653034": {
"description": "Email recipients for the upload link.",
"example": [
{
"email": "technik@pixx.io",
"language": "de"
}
],
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"title": "ArrayOfEmailLanguage",
"type": "array"
},
"ArrayOfEmailLanguage_6262333231": {
"description": "\u003cp\u003eThe email recipients of the share.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003enote:\u003c/strong\u003e the default language of the email is the language of the user who created the share.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
{
"email": "technik@pixx.io",
"language": "de"
}
],
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"title": "ArrayOfEmailLanguage",
"type": "array"
},
"ArrayOfFileDetail": {
"description": "the file-info displayed to the user in the share",
"example": [
"unimportantMetadata"
],
"items": {
"description": "The type of the FileDetail",
"enum": [
"basicMetadata",
"importantMetadata",
"licenseInfo",
"unimportantMetadata"
],
"example": "unimportantMetadata",
"title": "FileDetail",
"type": "string"
},
"title": "ArrayOfFileDetail",
"type": "array"
},
"ArrayOfFileInfo": {
"description": "List of files to attach to the upload link.",
"example": [
{
"id": 1,
"name": "file.jpg"
}
],
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"title": "ArrayOfFileInfo",
"type": "array"
},
"ArrayOfFileVariantInfo": {
"description": "An array of: FileVariantInfo\u003cbr\u003e**Caution:** a file can only be part of one variant-stack at a time",
"example": [
{
"id": 1,
"linkName": "link"
}
],
"items": {
"$ref": "#/components/schemas/FileVariantInfo"
},
"title": "ArrayOfFileVariantInfo",
"type": "array"
},
"ArrayOfFileVariantInfo_6165383237": {
"description": "An array of: FileVariantInfo\u003cbr\u003e**Caution:** a file can only be part of one variant-stack at a time",
"example": [
{
"id": 1,
"linkName": "link"
}
],
"items": {
"$ref": "#/components/schemas/FileVariantInfo"
},
"minItems": 2,
"title": "ArrayOfFileVariantInfo",
"type": "array"
},
"ArrayOfID": {
"description": "An array of: ID\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e admin-permission-groups can only be added by admin users\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3032313439": {
"description": "Adds model release IDs associated with uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3032666630": {
"description": "Filters for keywords with the specified permissionGroupIDs (connected with an OR).",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3232333834": {
"description": "An array of: ID\u003cbr\u003e**Condition:** collectionID is undefined",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"maxItems": 500,
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3236646338": {
"description": "List of permission group IDs the collection is shared with.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3238393134": {
"description": "\u003cp\u003eThe IDs of the files which were omitted from the download, because the current user does not have the permission to download those files. If the current user can download none of the specified files, the resource responds with an error.\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3261323666": {
"description": "Grants internal sharing to the specified user IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3335343934": {
"description": "The IDs of the license releases to delete.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3335616530": {
"description": "List of file IDs to include in the static collection.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3338633165": {
"description": "\u003cp\u003eThe file is added to the specified collections.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e the collections have to be static\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3339353163": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleases\u003c/code\u003e are removed from the file. No error is thrown when the specified \u003ccode\u003emodelRelease\u003c/code\u003e does not exist for the specified file(s).\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3362313931": {
"description": "Removes internal sharing for the specified user IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3363323734": {
"description": "Adds license release IDs associated with uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3433373233": {
"description": "List of user IDs the collection is shared with.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3438333439": {
"description": "The IDs of the model releases that should get deleted.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3438383333": {
"description": "\u003cp\u003eReturn only properties that have at least one of the specified propertyReleases. No other propertyReleases than the specified ones are returned in each propertyObject.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eAt most one of the parameters searchTerm,searchReleaseIDs, name shall be set.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3532303039": {
"description": "Filters collections by specific collection IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3536323937": {
"description": "Adds the specified file IDs to the collection.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3536333730": {
"description": "An array of: ID\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e permission editUsers is required\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e admin-permission-groups can only be added by admin users\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3564343231": {
"description": "Filters license releases belonging to the specified license IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3565343634": {
"description": "\u003cp\u003eThe IDs of the files to delete.\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"maxItems": 500,
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3630626364": {
"description": "The IDs of the properties which should be deleted.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3665346562": {
"description": "The IDs of the propertyReleases which should be deleted.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3734326635": {
"description": "Removes internal sharing for the specified permission group IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3736653937": {
"description": "Filters model releases by the specified model IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3738316462": {
"description": "Filter the propertyReleases for the specified property IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3766616665": {
"description": "Removes model release IDs from uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3831353462": {
"description": "An array of: ID\u003cbr\u003e**Condition:** collectionID is undefined",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3838346637": {
"description": "The ids filter allows retrieving specific standard metadata fields by ID.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3838393663": {
"description": "\u003cp\u003eThe propertyReleases are removed from the file. No error is thrown when the specified propertyRelease does not exist for the specified file(s).\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3838613731": {
"description": "An array of: ID\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e  If all files are removed from a variantStack or the variantStack only consists of one file, the variantStack is deleted automatically.\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3864393635": {
"description": "Grants internal sharing to the specified permission group IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3933333436": {
"description": "Sets file IDs to show as preview images in the collection.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_3938643731": {
"description": "Removes the specified file IDs from the collection.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6131373737": {
"description": "Adds property release IDs associated with uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6134316562": {
"description": "The license releases associated with the upload link.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6139656565": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleases\u003c/code\u003e are removed from the file. No error is thrown when the specified \u003ccode\u003elicenseRelease\u003c/code\u003e does not exist for the specified file(s).\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6162313334": {
"description": "\u003cp\u003eReturn only licenses that have at least one of the specified licenseReleases. No other licenseReleases than the specified ones are returned in each licenseObject. \u003cstrong\u003eAt most one of the parameters searchTerm, searchReleaseIDs, provider shall be set.\u003c/strong\u003e\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6164656565": {
"description": "Removes license release IDs from uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6233383138": {
"description": "\u003cp\u003eThe IDs of the files to update.\u003c/p\u003e\n\u003ch3\u003eImportant Consideration\u003c/h3\u003e\n\u003cp\u003e\u003cstrong\u003eAt least one of the parameters\u003c/strong\u003e \u003ccode\u003eids\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e shall be set.\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"maxItems": 500,
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6238646264": {
"description": "Filters the metadataFields for the specified metadataFieldIDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6263656132": {
"description": "Removes property release IDs from uploaded files.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6330323161": {
"description": "An array of: ID",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"maxItems": 500,
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6363333462": {
"description": "The IDs of the keywords to delete. Get the IDs from a keyword(s) GET request.\u003cbr\u003eAlternatively, you can use the 'keywords' parameter in order to delete a keyword by its name instead.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6363346334": {
"description": "The property releases associated with the upload link.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6364623939": {
"description": "Filters the collections by specific user IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6431643662": {
"description": "List of content entry IDs to remove from the license release.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6432343661": {
"description": "The IDs of the uploadLinks to delete.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6465373835": {
"description": "An array of: ID\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e permission editUsers is required\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e admin-permission-groups can only be removed by admin users\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6535393834": {
"description": "The IDs of the synonyms to delete.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6539616663": {
"description": "An array of: ID",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6563313461": {
"description": "The collection IDs to delete.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6635393666": {
"description": "Filters the downloadFormats by the specified IDs.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6638343235": {
"description": "\u003cp\u003eThe IDs of the files to convert.\u003c/p\u003e ",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"maxItems": 500,
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6665353530": {
"description": "Filter for model-releases.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfID_6666323637": {
"description": "The model releases associated with the upload link.",
"example": [
5
],
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"title": "ArrayOfID",
"type": "array"
},
"ArrayOfInt": {
"description": "\u003cp\u003eSpecify the destination layers you want to merge for your output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e this parameter is experimental and only works for input files with the file extension PSD.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: \"no layer selection\"",
"example": [
83
],
"items": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"title": "ArrayOfInt",
"type": "array"
},
"ArrayOfLanguageCode": {
"description": "An array of: LanguageCode",
"example": [
"de"
],
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"title": "ArrayOfLanguageCode",
"type": "array"
},
"ArrayOfLicenseData": {
"description": "List of content entries (name/value pairs) to add to the license release.",
"example": [
{
"name": "license name",
"value": "license value"
}
],
"items": {
"$ref": "#/components/schemas/LicenseData"
},
"title": "ArrayOfLicenseData",
"type": "array"
},
"ArrayOfLicenseData_6462343030": {
"description": "Key-value pairs defining the content of the license release.",
"example": [
{
"name": "license name",
"value": "license value"
}
],
"items": {
"$ref": "#/components/schemas/LicenseData"
},
"title": "ArrayOfLicenseData",
"type": "array"
},
"ArrayOfLicenseFileObject": {
"description": "The licenseReleases are added to the file. Duplicate licenseReleases are updated (the expiration date).",
"example": [
{
"expires": "2024-01-15 17:23:22",
"id": 5
}
],
"items": {
"$ref": "#/components/schemas/LicenseFileObject"
},
"title": "ArrayOfLicenseFileObject",
"type": "array"
},
"ArrayOfLicenseFileObject_3831353263": {
"description": "The propertyReleases are added to the file. Duplicate propertyReleases are updated (the expiration date).",
"example": [
{
"expires": "2024-01-15 17:23:22",
"id": 5
}
],
"items": {
"$ref": "#/components/schemas/LicenseFileObject"
},
"title": "ArrayOfLicenseFileObject",
"type": "array"
},
"ArrayOfLicenseFileObject_6133666264": {
"description": "The modelReleases are added to the file. Duplicate modelReleases are updated (the expiration date).",
"example": [
{
"expires": "2024-01-15 17:23:22",
"id": 5
}
],
"items": {
"$ref": "#/components/schemas/LicenseFileObject"
},
"title": "ArrayOfLicenseFileObject",
"type": "array"
},
"ArrayOfLicenseFileObject_6366363236": {
"description": "An array of: LicenseFileObject",
"example": [
{
"expires": "2024-01-15 17:23:22",
"id": 5
}
],
"items": {
"$ref": "#/components/schemas/LicenseFileObject"
},
"title": "ArrayOfLicenseFileObject",
"type": "array"
},
"ArrayOfMediaViewType": {
"description": "the media-views available for the user in the share",
"example": [
"TableGallery"
],
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"title": "ArrayOfMediaViewType",
"type": "array"
},
"ArrayOfMetadataFieldEditType": {
"description": "Filters the metadataFields by the specified editTypes (connected with an OR).",
"example": [
"none"
],
"items": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"title": "ArrayOfMetadataFieldEditType",
"type": "array"
},
"ArrayOfMetadataFieldType": {
"description": "Filters the metadataFields by the specified types (connected with an OR).",
"example": [
"pixxio"
],
"items": {
"description": "MetadataFieldType is a type for the metadata field type of a metadata field.",
"enum": [
"custom",
"exif",
"iptc",
"pixxio"
],
"example": "pixxio",
"title": "MetadataFieldType",
"type": "string"
},
"title": "ArrayOfMetadataFieldType",
"type": "array"
},
"ArrayOfMetadataObject": {
"description": "\u003cp\u003eWrite the text to the specified metadata-field. The metadata-field is determined by the ID here, and not by the name of the metadata-field.\u003c/p\u003e ",
"example": [
{
"action": "add",
"id": 1,
"value": "value"
}
],
"items": {
"$ref": "#/components/schemas/MetadataObject"
},
"title": "ArrayOfMetadataObject",
"type": "array"
},
"ArrayOfMetadataObject_3636663566": {
"description": "\u003cp\u003eSet the standard metadata-fields of the file.\u003c/p\u003e ",
"example": [
{
"action": "add",
"id": 1,
"value": "value"
}
],
"items": {
"$ref": "#/components/schemas/MetadataObject"
},
"title": "ArrayOfMetadataObject",
"type": "array"
},
"ArrayOfMetadataObject_6262373532": {
"description": "\u003cp\u003eWrite to the specified custom metadata-field. The metadata-field is determined by the ID here, and not by the name of the metadata-field.\u003c/p\u003e ",
"example": [
{
"action": "add",
"id": 1,
"value": "value"
}
],
"items": {
"$ref": "#/components/schemas/MetadataObject"
},
"title": "ArrayOfMetadataObject",
"type": "array"
},
"ArrayOfMetadataObject_6339393264": {
"description": "\u003cp\u003eSet the custom metadata-fields of the file.\u003c/p\u003e ",
"example": [
{
"action": "add",
"id": 1,
"value": "value"
}
],
"items": {
"$ref": "#/components/schemas/MetadataObject"
},
"title": "ArrayOfMetadataObject",
"type": "array"
},
"ArrayOfMetadataToCopy": {
"default": [
"all"
],
"description": "\u003cp\u003eWhich metadata to copy from the original file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if:\u003c/strong\u003e \u003ccode\u003eversionID\u003c/code\u003e or \u003ccode\u003ereplaceID\u003c/code\u003e is set\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e specified parameters OverWrite the metadata specified here\u003c/p\u003e \u003c/blockquote\u003e ",
"example": [
"filestateid"
],
"items": {
"description": "A metadata to copy.",
"enum": [
"all",
"createdate",
"creator",
"description",
"filestateid",
"isdownloadlocked",
"keywords",
"licensereleases",
"location",
"metadatafields",
"modelreleases",
"propertyreleases",
"rating",
"subject"
],
"example": "filestateid",
"title": "MetadataToCopy",
"type": "string"
},
"title": "ArrayOfMetadataToCopy",
"type": "array"
},
"ArrayOfPreviewFileOption": {
"description": "A PreviewFileOption determines the settings for a URL to the modified brandingLogo.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_3265383638": {
"description": "\u003cp\u003eParameter to get URLs to scaled versions of the preview file in the response field modifiedPreviewFileURLs. Use this parameter to display thumbnails in your application.\u003c/p\u003e ",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_3563326235": {
"description": "A PreviewFileOption determines the settings for a URL to the modified heroLogo.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_3637656136": {
"description": "A PreviewFileOption determines the settings for a URL to the modified heroBanner.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_6231613034": {
"description": "A PreviewFileOption determines the settings for a URL to the modified collection preview file.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_6263303830": {
"description": "Preview options for generating preview file URLs.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_6338326632": {
"description": "An array of: PreviewFileOption",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"maxItems": 10,
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfPreviewFileOption_6662303363": {
"description": "Preview file options used for generating modified preview URLs.",
"example": [
{
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
}
],
"items": {
"$ref": "#/components/schemas/PreviewFileOption"
},
"title": "ArrayOfPreviewFileOption",
"type": "array"
},
"ArrayOfResponseFields": {
"default": [
"id"
],
"description": "Specifies which fields to include for the fileState object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"description",
"forceComment",
"id",
"isArchive",
"name",
"order"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3037383362": {
"default": [
"id"
],
"description": "Specifies which fields to include for license releases.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"content",
"fileName",
"fileURL",
"id",
"license",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3037623030": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"description",
"forceComment",
"id",
"isArchive",
"name",
"order"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3061373665": {
"default": [
"id",
"progress",
"isFinished"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"jobType",
"jobData"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"error",
"id",
"isFinished",
"isStarted",
"jobData",
"jobType",
"modifyDate",
"progress",
"success"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3062663037": {
"default": [
"id"
],
"description": "Specifies which fields to include for the directory object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"hasChildren",
"id",
"name",
"path"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3065323261": {
"default": [
"id",
"displayName"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003eNote: the responseField \"uploadMandatoryDefaultMetadataFields\" is deprecated. Please use the responseField \"uploadObligations\" instead.",
"example": [
"id",
"firstName",
"lastName"
],
"items": {
"description": "a string term",
"enum": [
"apiKeys",
"azureActiveDirectoryID",
"createDate",
"directoryPermissions",
"displayName",
"downloadFormatPermissions",
"email",
"externalID",
"externalTargetEmail",
"fileStatePermissions",
"firstName",
"homeDirectory",
"id",
"isActive",
"isExternal",
"isLinked",
"isReadOnly",
"isSupportUser",
"language",
"lastName",
"modifyDate",
"permissionGroups",
"permissions",
"refreshToken",
"twoFactorAuthSetUp",
"uploadMandatoryDefaultMetadataFields",
"uploadObligations",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3066363732": {
"default": [
"id",
"name",
"editType",
"type",
"isEditable",
"selectionOptions",
"translationState",
"value",
"parentCondition"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"editType",
"id",
"isEditable",
"name",
"parentCondition",
"selectionOptions",
"translationState",
"type",
"value"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3131396338": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name"
],
"items": {
"description": "a string term",
"enum": [
"hasChildren",
"id",
"name",
"path"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3134343137": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"content",
"createDate",
"fileName",
"fileURL",
"id",
"license",
"modifyDate",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3134353537": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name"
],
"items": {
"description": "a string term",
"enum": [
"hasChildren",
"id",
"idPath",
"name",
"path"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3136666163": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"createDate",
"fileName",
"fileURL",
"id",
"modifyDate",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3137636234": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"createDate",
"description"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"description",
"id",
"modifyDate",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3139633563": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"address",
"id",
"name",
"owner"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3163666365": {
"default": [
"id"
],
"description": "Specifies which fields to include in the user object response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3165333963": {
"default": [
"id"
],
"description": "Specifies which fields to include in the sharedUsers response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3230393038": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"userName",
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3230393165": {
"default": [
"id",
"name"
],
"description": "Specifies which fields to include in the response object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"description",
"directory",
"emails",
"expirationDate",
"faceRecognitionDisabled",
"fileState",
"filesQuantity",
"id",
"isActive",
"isDisabled",
"keywords",
"licenseReleases",
"modelReleases",
"modifyDate",
"name",
"notificationText",
"propertyReleases",
"shareKey",
"showAllLicenseReleases",
"showAllModelReleases",
"showAllPropertyReleases",
"uploadCondition",
"user",
"validityPeriod"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3230663233": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"editType",
"id",
"modifyDate",
"name",
"parentCondition",
"selectionOptions",
"translationState"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3232323166": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"description",
"directory",
"emails",
"expirationDate",
"faceRecognitionDisabled",
"fileState",
"filesQuantity",
"id",
"isActive",
"isDisabled",
"keywords",
"licenseReleases",
"modelReleases",
"modifyDate",
"name",
"notificationText",
"propertyReleases",
"shareKey",
"showAllLicenseReleases",
"showAllModelReleases",
"showAllPropertyReleases",
"uploadCondition",
"user",
"validityPeriod"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3263373839": {
"default": [
"id"
],
"description": "Specifies which fields to include in the sharedPermissionGroups response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"id",
"isAdmin",
"isExternal",
"isLinked",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3264373538": {
"default": [
"id",
"firstName",
"lastName"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"createDate",
"modelReleases"
],
"items": {
"description": "a string term",
"enum": [
"birthDate",
"createDate",
"email",
"firstName",
"id",
"lastName",
"modelReleases",
"modifyDate"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3265363562": {
"default": [
"id",
"hostNames"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"brandingLogoFileURL",
"collections",
"collectionsOrder",
"createDate",
"features",
"hasGeneralPassword",
"hasUserRegistration",
"heroBannerFileURL",
"heroLogoFileURL",
"heroSlogan",
"hostNames",
"id",
"isActive",
"languages",
"mainHostName",
"modifiedBrandingLogoPreviewFileURLs",
"modifiedHeroBannerPreviewFileURLs",
"modifiedHeroLogoPreviewFileURLs",
"modifyDate",
"name",
"originalDownloadFormatTypes",
"portalPackage",
"protectedCollections",
"restrictAccess",
"translationState",
"useSSO"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3265383563": {
"default": [
"id"
],
"description": "Specifies which fields to include in shared permission groups.",
"example": [
"id"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3265383739": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"id",
"isAdmin",
"isExternal",
"isLinked",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3330343636": {
"default": [
"id"
],
"description": "Specifies which fields to include in the response object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"createDate",
"fileName",
"fileURL",
"id",
"model",
"modifyDate",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3335383636": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"color"
],
"items": {
"description": "a string term",
"enum": [
"color",
"description",
"forceComment",
"id",
"isArchive",
"name",
"order"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3337313835": {
"default": [
"id",
"name"
],
"description": "Only the specified fields appear in the response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"hasChildren",
"id",
"modifyDate",
"name",
"parentID",
"permissions",
"quantity",
"quantityWithSubdirectories"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3365313263": {
"default": [
"id"
],
"description": "Specifies which fields to include in the preview files response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3430666563": {
"default": [
"id"
],
"description": "Specifies which fields to include in the assetNavigator response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"assetNavigatorCategories",
"description",
"id",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3434616465": {
"default": [
"id"
],
"description": "Specifies which fields to include for model releases.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"model",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3461616264": {
"default": [
"id"
],
"description": "Specifies which fields to include in the nested model object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"birthDate",
"email",
"firstName",
"id",
"lastName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3463653737": {
"default": [
"id",
"createDate",
"fileURL"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"createDate",
"downloadFormat"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"downloadFormat",
"file",
"fileExtension",
"fileName",
"fileSize",
"fileURL",
"id",
"isOriginal",
"isPreview",
"modifyDate"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3466646564": {
"default": [
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"name"
],
"items": {
"description": "a string term",
"enum": [
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3531323066": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"colorspace",
"density",
"formatConversion",
"height",
"id",
"maxSize",
"name",
"quality",
"unit",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3532303631": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"address",
"createDate",
"id",
"modifyDate",
"name",
"owner",
"propertyReleases"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3532363535": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"isEditable",
"isSearchable",
"metadata",
"modifyDate"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3538383463": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"name",
"id"
],
"items": {
"description": "a string term",
"enum": [
"colorspace",
"density",
"formatConversion",
"height",
"id",
"maxSize",
"name",
"quality",
"unit",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3563333235": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"displayName",
"userName"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3564306339": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003eNote: the responseField \"uploadMandatoryDefaultMetadataFields\" is deprecated. Please use the responseField \"uploadObligations\" instead.",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"directoryPermissions",
"downloadFormatPermissions",
"fileStatePermissions",
"id",
"modifyDate",
"name",
"permissions",
"usersCount"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3565656437": {
"default": [
"id",
"name"
],
"description": "Specifies which fields to include in the collection response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"assetNavigator",
"createDate",
"description",
"filesQuantity",
"filesQuantityWithFilter",
"id",
"isDeleted",
"isDynamic",
"isSharedExternally",
"isSharedGlobally",
"isSharedInternally",
"modifyDate",
"name",
"permissions",
"previewFiles",
"sharedPermissionGroups",
"sharedUsers",
"translationState",
"user",
"userHasPermissionForCollection"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3631626365": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"termsOfUse"
],
"items": {
"description": "a string term",
"enum": [
"allowComments",
"allowDownloads",
"allowUpvotes",
"collection",
"createDate",
"description",
"downloadFormats",
"emails",
"expirationDate",
"exportProof",
"fileDetails",
"filesQuantity",
"forceDownloadProof",
"forceWatermark",
"hasDownloadFormatFree",
"hasDownloadFormatOriginal",
"hasDownloadFormatPreview",
"id",
"isDisabled",
"lastOpenedDate",
"mediaViews",
"modifyDate",
"name",
"noAds",
"notificationText",
"numberOfComments",
"numberOfDownloads",
"numberOfUpvotes",
"openedCounter",
"securedWithPassword",
"shareKey",
"termsOfUse",
"user",
"validityPeriod"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3634336166": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name"
],
"items": {
"description": "a string term",
"enum": [
"description",
"id",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3661346537": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name"
],
"items": {
"description": "a string term",
"enum": [
"id",
"isAdmin",
"isExternal",
"isLinked",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3664663233": {
"default": [
"id"
],
"description": "Specifies which fields to include for the user object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3666356263": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003e**Caution:** the response-field **originalFileURL** is deprecated, do not use!",
"example": [
"id",
"fileName",
"fileExtension"
],
"items": {
"description": "a string term",
"enum": [
"clipFileURL",
"colorspace",
"description",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isCheckedOut",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isMarked",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"metadataFields",
"modelReleases",
"modifiedPreviewFileURLs",
"orientation",
"pixel",
"previewFileHeight",
"previewFileIsReplaced",
"previewFileURL",
"previewFileWidth",
"propertyReleases",
"rating",
"rotation",
"subject",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3731326163": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003e**Caution:** the response-field **originalFileURL** is deprecated, do not use!",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"clipFileURL",
"colorspace",
"description",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isCheckedOut",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isMarked",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"metadataFields",
"modelReleases",
"modifiedPreviewFileURLs",
"orientation",
"pixel",
"previewFileHeight",
"previewFileIsReplaced",
"previewFileURL",
"previewFileWidth",
"propertyReleases",
"rating",
"rotation",
"subject",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3731366165": {
"default": [
"id",
"provider"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"licenseReleases",
"modifyDate",
"provider"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3731636439": {
"default": [
"id",
"synonym1"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"createDate",
"modifyDate"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"modifyDate",
"synonym1",
"synonym10",
"synonym11",
"synonym12",
"synonym13",
"synonym14",
"synonym15",
"synonym16",
"synonym17",
"synonym18",
"synonym19",
"synonym2",
"synonym20",
"synonym3",
"synonym4",
"synonym5",
"synonym6",
"synonym7",
"synonym8",
"synonym9"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3738396163": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"isExternal"
],
"items": {
"description": "a string term",
"enum": [
"id",
"isAdmin",
"isExternal",
"isLinked",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3739306633": {
"default": [
"id",
"name"
],
"description": "Specifies which fields to include in the response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"assetNavigator",
"createDate",
"description",
"filesQuantity",
"filesQuantityWithFilter",
"id",
"isDeleted",
"isDynamic",
"isSharedExternally",
"isSharedGlobally",
"isSharedInternally",
"modifyDate",
"name",
"permissions",
"previewFiles",
"sharedPermissionGroups",
"sharedUsers",
"translationState",
"user",
"userHasPermissionForCollection"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3836653062": {
"default": [
"id"
],
"description": "Specifies which fields to include in shared users.",
"example": [
"id"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3930343466": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"createDate",
"fileName",
"fileURL",
"id",
"modifyDate",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3936383835": {
"default": [
"id"
],
"description": "Specifies which fields to include for the model.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"birthDate",
"email",
"firstName",
"id",
"lastName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3936613265": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3962646563": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"description"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"description",
"filesQuantity",
"id",
"isDynamic",
"isSharedExternally",
"isSharedGlobally",
"isSharedInternally",
"name",
"previewFiles",
"userHasPermissionForCollection"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3963393231": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"description",
"validityPeriod"
],
"items": {
"description": "a string term",
"enum": [
"allowComments",
"allowDownloads",
"allowUpvotes",
"collection",
"createDate",
"description",
"downloadFormats",
"emails",
"expirationDate",
"exportProof",
"fileDetails",
"filesQuantity",
"forceDownloadProof",
"forceWatermark",
"hasDownloadFormatFree",
"hasDownloadFormatOriginal",
"hasDownloadFormatPreview",
"id",
"isDisabled",
"lastOpenedDate",
"mediaViews",
"modifyDate",
"name",
"noAds",
"notificationText",
"numberOfComments",
"numberOfDownloads",
"numberOfUpvotes",
"openedCounter",
"securedWithPassword",
"shareKey",
"termsOfUse",
"user",
"validityPeriod"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3965376634": {
"default": [
"id"
],
"description": "Specifies which fields to include in the user object.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_3966356536": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"hasChildren",
"id",
"modifyDate",
"name",
"parentID",
"path",
"permissions",
"quantity",
"quantityWithSubdirectories"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6132636239": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"colorspace",
"createDate",
"density",
"formatConversion",
"height",
"id",
"maxSize",
"modifyDate",
"name",
"quality",
"translationState",
"unit",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6138383435": {
"default": [
"id"
],
"description": "Specifies which fields to include for property releases.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6161373435": {
"default": [
"id"
],
"description": "Specifies which fields to include in the previewFiles response.\u003cbr\u003e**Caution:** the response-field **originalFileURL** is deprecated, do not use!",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"clipFileURL",
"colorspace",
"description",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isCheckedOut",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isMarked",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"metadataFields",
"modelReleases",
"modifiedPreviewFileURLs",
"orientation",
"pixel",
"previewFileHeight",
"previewFileIsReplaced",
"previewFileURL",
"previewFileWidth",
"propertyReleases",
"rating",
"rotation",
"subject",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6166623062": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"content",
"fileName",
"fileURL",
"id",
"license",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6231343137": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"color"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"model",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6232363936": {
"default": [
"id",
"displayName"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"firstName",
"lastName"
],
"items": {
"description": "a string term",
"enum": [
"apiKeys",
"azureActiveDirectoryID",
"createDate",
"displayName",
"email",
"externalID",
"firstName",
"homeDirectory",
"id",
"isActive",
"isExternal",
"isLinked",
"isReadOnly",
"isSupportUser",
"language",
"lastName",
"modifyDate",
"permissionGroups",
"refreshToken",
"twoFactorAuthSetUp",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6232646565": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"shareKey"
],
"items": {
"description": "a string term",
"enum": [
"description",
"diskSpaceExceeded",
"displayUserName",
"id",
"isActive",
"isDisabled",
"name",
"remainingFileUploads",
"shareKey",
"uploadCondition"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6234343463": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"createDate",
"description",
"id",
"isArchive",
"modifyDate",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6235343563": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"displayName",
"email",
"firstName",
"id",
"isActive",
"isExternal",
"isLinked",
"lastName",
"userName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6237306637": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"editType",
"id",
"indexedForSearchTerm",
"isImportant",
"isSearchable",
"modifyDate",
"name",
"selectionTerms",
"type"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6238643232": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"address",
"id",
"name",
"owner"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6262333761": {
"default": [
"id",
"fileName"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003e**Caution:** the response-field **originalFileURL** is deprecated, do not use!",
"example": [
"staticCollections",
"versions",
"metadata"
],
"items": {
"description": "a string term",
"enum": [
"clipFileURL",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"importantMetadata",
"isArchived",
"isCheckedOut",
"isConvertible",
"isDeleted",
"isDownloadLocked",
"isMainVersion",
"isMarked",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"metadata",
"metadataFields",
"modelReleases",
"modifiedPreviewFileURLs",
"modifyDate",
"orientation",
"permissions",
"pixel",
"previewFileURL",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"unimportantMetadata",
"uploadDate",
"usePanoramaViewer",
"user",
"variantStack",
"versions",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6331646433": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"model",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6332613864": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"content",
"fileName",
"fileURL",
"id",
"license",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6338653162": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"id",
"provider"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6339313436": {
"default": [
"id",
"fileName"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e \u003cbr\u003e**Caution:** the response-field **originalFileURL** is deprecated, do not use!",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"clipFileURL",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"importantMetadata",
"isArchived",
"isCheckedOut",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isMarked",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"metadataFields",
"modelReleases",
"modifiedPreviewFileURLs",
"modifyDate",
"orientation",
"permissions",
"pixel",
"previewFileURL",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"variantStack",
"versions",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6365323462": {
"default": [
"id",
"hostNames"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"activateUserAutomatically",
"addShadowToFont",
"automaticallyActivatedDomains",
"backgroundColor",
"brandURL",
"brandingLogoFileURL",
"collections",
"collectionsOrder",
"cookieLinkPrivacyPage",
"cookiePlacement",
"cookieTextShort",
"createDate",
"customMetadataIDs",
"defaultMetadataFields",
"domainNames",
"downloadFormats",
"emailReceiver",
"features",
"filterOptions",
"footerText",
"forceDownloadProof",
"forceWatermark",
"hasDownloadFormatFree",
"hasDownloadFormatOriginal",
"hasDownloadFormatPreview",
"hasGeneralPassword",
"hasUserRegistration",
"hasWhitelabel",
"heroArrowColor",
"heroBannerFileURL",
"heroFontColor",
"heroLogoColor",
"heroLogoFileURL",
"heroSlogan",
"hostNames",
"id",
"isActive",
"landingPageOptions",
"languages",
"licenseReleases",
"mainHostName",
"mediaViews",
"modelReleases",
"modifiedBrandingLogoPreviewFileURLs",
"modifiedHeroBannerPreviewFileURLs",
"modifiedHeroLogoPreviewFileURLs",
"modifyDate",
"name",
"originalDownloadFormatTypes",
"portalPackage",
"preferredMode",
"preferredTitle",
"propertyReleases",
"protectedCollections",
"restrictAccess",
"searchFields",
"serverAliases",
"serverDomain",
"showAllLicenseReleases",
"showAllModelReleases",
"showAllPropertyReleases",
"showBorder",
"showCookieInformation",
"showCreateLinkToFileTab",
"showFileType",
"showLicenseReleaseFile",
"showModelReleaseFile",
"showPropertyReleaseFile",
"showStartScreen",
"sortOptions",
"standardMetadataIDs",
"startScreenText",
"translationState",
"useSSO",
"useSemanticSearch"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6431323934": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"hasChildren",
"id",
"name",
"path"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6435376236": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"model",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6438613433": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"description",
"id",
"name"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6461373734": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"color",
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"description",
"forceComment",
"id",
"isArchive",
"name",
"order"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6466633964": {
"default": [
"id"
],
"description": "Specifies which fields to include in the response.",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"createDate",
"fileName",
"fileURL",
"id",
"model",
"modifyDate",
"name",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6530326635": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"name",
"density"
],
"items": {
"description": "a string term",
"enum": [
"colorspace",
"density",
"formatConversion",
"height",
"id",
"maxSize",
"name",
"quality",
"unit",
"width"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6534373730": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"modifyDate",
"name",
"permissionGroups"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6534613936": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id",
"createDate",
"text"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"modifyDate",
"name",
"placements",
"text",
"translationState"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6537663233": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6538396137": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"description",
"filesQuantity",
"id",
"isDynamic",
"isSharedExternally",
"isSharedGlobally",
"isSharedInternally",
"name",
"previewFiles",
"userHasPermissionForCollection"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6630366465": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6631313265": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"color",
"fileName",
"fileURL",
"id",
"name",
"property",
"releaseCreateDate",
"showFile",
"showWarningMessage",
"translationState",
"warningMessage"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6632303534": {
"default": [
"id"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"birthDate",
"email",
"firstName",
"id",
"lastName"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6638306438": {
"default": [
"id",
"email"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"company",
"createDate",
"department",
"email",
"firstName",
"id",
"isActive",
"isDoubleOptInVerified",
"language",
"lastName",
"modifyDate"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6639616330": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"hasChildren",
"id",
"modifyDate",
"name",
"parentID",
"path",
"permissions",
"quantity",
"quantityWithSubdirectories",
"totalFileSize",
"totalFileSizeWithSubdirectories"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6664376237": {
"default": [
"id",
"name"
],
"description": "\u003cp\u003eOnly the specified fields appear in the response. \u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only specify the fields which are required for your application. Fewer response fields significantly reduce the workload on the server, which also leads to increasing performance.\u003c/p\u003e ",
"example": [
"createDate",
"id"
],
"items": {
"description": "a string term",
"enum": [
"createDate",
"id",
"isAdmin",
"modifyDate",
"name",
"usersCount"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfResponseFields_6664396236": {
"default": [
"id"
],
"description": "Specifies which fields to include in asset navigator.",
"example": [
"id"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "Array of ResponseFields",
"type": "array"
},
"ArrayOfString": {
"description": "An array of: String",
"example": [
"A string with any formatting"
],
"items": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"title": "ArrayOfString",
"type": "array"
},
"ArrayOfTerm": {
"description": "An array of: Term",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_3464383832": {
"description": "\u003cp\u003eThe metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to truncate data from arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_3636366534": {
"description": "Adds keywords to uploaded files.",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6133636362": {
"description": "The keywords associated with the uploadLink.",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6238343364": {
"description": "global settings determine whether these keywords are added or replaced",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6239323666": {
"description": "\u003cp\u003eThe keywords are removed from the file. No error is thrown when the specified keyword does not exist for the specified file(s).\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6263306663": {
"description": "\u003cp\u003eThe keywords are added to the file, replacing the keywords found in the metadata of the file itself Duplicate keywords are not added, but no error is thrown.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"maxItems": 100,
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6331393133": {
"deprecated": true,
"description": "\u003cp\u003eThe \u003ccode\u003ekeywordsRecognition\u003c/code\u003e are added to the file. Duplicate keywords are not added, but no error is thrown. \u003ccode\u003ekeywordsRecognition\u003c/code\u003e stores the keywords from the Image-Recognition Algorithm from Clarifai. This field should not be used for other data.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6435303739": {
"description": "\u003cp\u003eThe keywords are added to the file, additionally to the keywords found in the metadata of the file itself Duplicate keywords are not added, but no error is thrown.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"maxItems": 100,
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6464643138": {
"description": "\u003cp\u003eThe keywords are added to the file. Duplicate keywords are not added, but no error is thrown.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6533376634": {
"description": "\u003cp\u003eThe keywordsRecognition are removed from the file. No error is thrown when the specified keyword does not exist for the specified file(s). KeywordsRecognition stores the keywords from the Image-Recognition Algorithm from Clarifai. This field should not be used for other data.\u003c/p\u003e ",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6565653631": {
"description": "The keyword strings to delete from the system.\u003cbr\u003eAlternatively, you can use the 'ids' parameter in order to delete a keyword by its ID instead.",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfTerm_6630663734": {
"description": "Removes keywords from uploaded files.",
"example": [
"aaaAA"
],
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"title": "ArrayOfTerm",
"type": "array"
},
"ArrayOfUint": {
"description": "\u003cp\u003eSpecify the destination layers you want to merge for your output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e this parameter is experimental and only works for input files with the file extension PSD.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: \"no layer selection\"",
"example": [
93
],
"items": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"title": "ArrayOfUint",
"type": "array"
},
"ArraySchema": {
"description": "The removed licenseReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3033396164": {
"description": "The added fileStatesToShow.",
"items": {
"$ref": "#/components/schemas/FileStateInfo"
},
"type": "array"
},
"ArraySchema_3033653264": {
"description": "The fileStates.",
"items": {
"$ref": "#/components/schemas/FileState_6161353832"
},
"type": "array"
},
"ArraySchema_3035326536": {
"description": "The added features.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3035636363": {
"description": "The old metadataFieldsOrder.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3035643235": {
"description": "The removed languages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3038633065": {
"description": "The ids of the modified files which weren't modified.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_3039306363": {
"description": "The old previewFileIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3061616539": {
"description": "The renamed selectionTerms.",
"items": {
"$ref": "#/components/schemas/MetadataFieldRenameSelectionTerm"
},
"type": "array"
},
"ArraySchema_3063633030": {
"description": "The users with which the collection is unshared.",
"items": {
"$ref": "#/components/schemas/UserInfo_6263373834"
},
"type": "array"
},
"ArraySchema_3131366263": {
"description": "The added files.",
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
"ArraySchema_3133323865": {
"description": "The added modelFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_3133613333": {
"description": "The groups which have been deactivated.",
"items": {
"$ref": "#/components/schemas/AzureActiveDirectoryGroup"
},
"type": "array"
},
"ArraySchema_3135343637": {
"description": "The added uploadObligations.",
"items": {
"$ref": "#/components/schemas/UploadObligation"
},
"type": "array"
},
"ArraySchema_3135383536": {
"description": "The ids of the deleted files which weren't deleted.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_3139333730": {
"description": "The removed propertyReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3164636261": {
"description": "The added directoryIDsToUpload.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3230363237": {
"description": "The new previewFileIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3231333833": {
"description": "The removed automaticallyActivatedDomains.",
"items": {
"description": "A domain of an url",
"example": "www.google.com",
"title": "Domain",
"type": "string"
},
"type": "array"
},
"ArraySchema_3232376432": {
"description": "The removed directoryIDsToShow.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3232386430": {
"description": "The removed pages.",
"items": {
"$ref": "#/components/schemas/PortalPageInfo"
},
"type": "array"
},
"ArraySchema_3235656130": {
"description": "The propertyReleases.",
"items": {
"$ref": "#/components/schemas/PropertyRelease_6136373361"
},
"type": "array"
},
"ArraySchema_3236323463": {
"description": "The deleted keywordsRecognition.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3261663434": {
"description": "The added unlockedCustomerGroups.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3262306338": {
"description": "The groups which have been removed.",
"items": {
"$ref": "#/components/schemas/AzureActiveDirectoryGroup"
},
"type": "array"
},
"ArraySchema_3262343932": {
"description": "The groups which have been added.",
"items": {
"$ref": "#/components/schemas/AzureActiveDirectoryGroup"
},
"type": "array"
},
"ArraySchema_3263613436": {
"description": "The removed files.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3265336238": {
"description": "The removed eventKeys.",
"items": {
"description": "EventKey represents the key of an event.",
"enum": [
"apiKeyCreated",
"apiKeyDeleted",
"apiKeyModifiedIPRangeAdded",
"apiKeyModifiedIPRangeRemoved",
"apiKeyModifiedIsActive",
"apiKeyModifiedName",
"apiKeyModifiedScopeID",
"apiKeyModifiedUserID",
"assetNavigatorCategoryCreated",
"assetNavigatorCategoryDeleted",
"assetNavigatorCategoryModifiedMetadataFieldID",
"assetNavigatorCategoryModifiedOrder",
"assetNavigatorCategoryTranslationCreated",
"assetNavigatorCategoryTranslationModifiedLanguage",
"assetNavigatorCategoryTranslationModifiedName",
"assetNavigatorCreated",
"assetNavigatorDeleted",
"assetNavigatorModifiedAssetNavigatorCategory",
"assetNavigatorModifiedDescription",
"assetNavigatorModifiedName",
"azureActiveDirectoryCreated",
"azureActiveDirectoryDeleted",
"azureActiveDirectoryModifiedClientID",
"azureActiveDirectoryModifiedClientSecret",
"azureActiveDirectoryModifiedDeleteMode",
"azureActiveDirectoryModifiedGroupUpdated",
"azureActiveDirectoryModifiedGroupsActivated",
"azureActiveDirectoryModifiedGroupsAdded",
"azureActiveDirectoryModifiedGroupsDeactivated",
"azureActiveDirectoryModifiedGroupsRemoved",
"azureActiveDirectoryModifiedIPRangeAdded",
"azureActiveDirectoryModifiedIPRangeRemoved",
"azureActiveDirectoryModifiedName",
"azureActiveDirectoryModifiedNewUserDataOwner",
"azureActiveDirectoryModifiedRecursive",
"azureActiveDirectoryModifiedSyncTime",
"azureActiveDirectoryModifiedTenantID",
"collectionCreated",
"collectionDeleted",
"collectionModifiedAssetNavigatorID",
"collectionModifiedFilesAdded",
"collectionModifiedFilesCommented",
"collectionModifiedFilesRemoved",
"collectionModifiedPreviewFileIDs",
"collectionModifiedUserID",
"collectionSharedExternally",
"collectionSharedInternally",
"collectionTranslationCreated",
"collectionTranslationDeleted",
"collectionTranslationModifiedDescription",
"collectionTranslationModifiedLanguage",
"collectionTranslationModifiedName",
"collectionUnsharedInternally",
"commentCreated",
"commentDeleted",
"customMetadataCreated",
"customMetadataDeleted",
"customMetadataLanguagesCreated",
"customMetadataLanguagesDeleted",
"customMetadataLanguagesModifiedName",
"customMetadataModifiedParentConditionCustomMetadataID",
"customMetadataModifiedParentConditionCustomMetadataOptionIDs",
"customMetadataOptionLanguagesCreated",
"customMetadataOptionLanguagesDeleted",
"customMetadataOptionLanguagesModifiedName",
"customMetadataOptionsCreated",
"customMetadataOptionsDeleted",
"customMetadataOptionsModifiedOrder",
"customMetadataParentConditionCreated",
"customMetadataParentConditionDeleted",
"directLinkCreated",
"directLinkDeleted",
"directLinkModifiedDownloadFormatID",
"directLinkModifiedFileID",
"directLinkModifiedFileName",
"directLinkModifiedFileSize",
"directoryCreated",
"directoryDeleted",
"directoryModifiedName",
"directoryModifiedParentDirectoryID",
"downloadCreated",
"downloadDeleted",
"downloadFormatCreated",
"downloadFormatDeleted",
"downloadFormatModifiedColorspace",
"downloadFormatModifiedDensity",
"downloadFormatModifiedFormatConversion",
"downloadFormatModifiedHeight",
"downloadFormatModifiedName",
"downloadFormatModifiedQuality",
"downloadFormatModifiedResize",
"downloadFormatModifiedResizeUnit",
"downloadFormatModifiedWidth",
"downloadFormatTranslationCreated",
"downloadFormatTranslationModifiedLanguage",
"downloadFormatTranslationModifiedName",
"downloadModifiedDownloadFormatID",
"downloadModifiedFileIDsAdded",
"downloadModifiedFileIDsRemoved",
"downloadModifiedUserID",
"downloadModifiedUserName",
"duplicateFileCreated",
"duplicateFileDeleted",
"emailCustomTemplateCreated",
"emailCustomTemplateDeleted",
"emailCustomTemplateModifiedBody",
"emailCustomTemplateModifiedLanguage",
"emailCustomTemplateModifiedName",
"emailCustomTemplateModifiedSubject",
"emailCustomTemplateModifiedType",
"externalShareCreated",
"externalShareDeleted",
"externalShareModifiedAllowComments",
"externalShareModifiedAllowDownloads",
"externalShareModifiedAllowUpvotes",
"externalShareModifiedDescription",
"externalShareModifiedDownloadFormatsAdded",
"externalShareModifiedDownloadFormatsRemoved",
"externalShareModifiedEmailsAdded",
"externalShareModifiedFileDetailsAdded",
"externalShareModifiedFileDetailsRemoved",
"externalShareModifiedFilesAdded",
"externalShareModifiedFilesRemoved",
"externalShareModifiedForceDownloadProof",
"externalShareModifiedForceWatermark",
"externalShareModifiedHasDownloadFormatFree",
"externalShareModifiedHasDownloadFormatOriginal",
"externalShareModifiedHasDownloadFormatPreview",
"externalShareModifiedIsDisabled",
"externalShareModifiedMediaViewsAdded",
"externalShareModifiedMediaViewsRemoved",
"externalShareModifiedName",
"externalShareModifiedNotificationText",
"externalShareModifiedPassword",
"externalShareModifiedTermsOfUse",
"externalShareModifiedUserID",
"externalShareModifiedValidityPeriod",
"externalShareViewed",
"externalSharesCommentCreated",
"externalSharesCommentDeleted",
"externalSharesUpvoteCreated",
"externalSharesUpvoteDeleted",
"fileCreated",
"fileDeleted",
"fileDeletedDuplicate",
"fileDownloaded",
"fileModifiedCollectionIDsAdded",
"fileModifiedCollectionIDsRemoved",
"fileModifiedCreateDate",
"fileModifiedCreator",
"fileModifiedDescription",
"fileModifiedDirectoryIDPath",
"fileModifiedExternalShareIDsAdded",
"fileModifiedExternalShareIDsRemoved",
"fileModifiedFaces",
"fileModifiedFileName",
"fileModifiedFileStateID",
"fileModifiedIsCheckedOut",
"fileModifiedIsDownloadLocked",
"fileModifiedKeywordsAdded",
"fileModifiedKeywordsDeleted",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedLanguageCodesAdded",
"fileModifiedLanguageCodesRemoved",
"fileModifiedLicenseFilesAdded",
"fileModifiedLicenseFilesDeleted",
"fileModifiedLocation",
"fileModifiedMainVersionFileID",
"fileModifiedMarkedUserIDsAdded",
"fileModifiedMarkedUserIDsRemoved",
"fileModifiedMetadataFieldDate",
"fileModifiedMetadataFieldFocalPoint",
"fileModifiedMetadataFieldLanguagesAdded",
"fileModifiedMetadataFieldLanguagesDeleted",
"fileModifiedMetadataFieldLocation",
"fileModifiedMetadataFieldMultiSelectionsAdded",
"fileModifiedMetadataFieldMultiSelectionsDeleted",
"fileModifiedMetadataFieldOrientation",
"fileModifiedMetadataFieldSelection",
"fileModifiedMetadataFieldText",
"fileModifiedMetadataFieldTruncate",
"fileModifiedModelFilesAdded",
"fileModifiedModelFilesDeleted",
"fileModifiedPropertyFilesAdded",
"fileModifiedPropertyFilesDeleted",
"fileModifiedRating",
"fileModifiedRecognizedText",
"fileModifiedRotation",
"fileModifiedSubject",
"fileModifiedUploadDate",
"fileModifiedUploadLink",
"fileModifiedUserID",
"fileModifiedVariantStack",
"fileReplaced",
"fileReplacedPreviewFile",
"fileRestoredPreviewFile",
"fileStateCreated",
"fileStateDeleted",
"fileStateModifiedColor",
"fileStateModifiedDescription",
"fileStateModifiedForceComment",
"fileStateModifiedIsArchive",
"fileStateModifiedName",
"fileStateModifiedOrder",
"filesCustomFieldCreated",
"filesCustomFieldDeleted",
"filesCustomFieldModifiedValue",
"filesCustomFieldModifiedValueCustomFieldsOptionID",
"filesCustomFieldModifiedValueCustomFieldsOptionIDs",
"filterCreated",
"filterDeleted",
"filterModifiedFilter",
"filterModifiedName",
"filterModifiedUserID",
"generalSettingsModifiedAllowConcurrentLogin",
"generalSettingsModifiedAllowDuplicates",
"generalSettingsModifiedCheckSessionFiles",
"generalSettingsModifiedDailyAPILimit",
"generalSettingsModifiedDataPrivacyText",
"generalSettingsModifiedDataPrivacyURL",
"generalSettingsModifiedDefaultLanguageCodesAdded",
"generalSettingsModifiedDefaultLanguageCodesRemoved",
"generalSettingsModifiedDirectoriesInMediaview",
"generalSettingsModifiedDownloadCacheSize",
"generalSettingsModifiedDownloadCacheStoreCroppedFiles",
"generalSettingsModifiedDownloadCacheTime",
"generalSettingsModifiedDownloadLockedText",
"generalSettingsModifiedEnableForgotPasswordOption",
"generalSettingsModifiedExternalShareAlias",
"generalSettingsModifiedFaceRecognition",
"generalSettingsModifiedGeneralUploadText",
"generalSettingsModifiedKeywordUploadText",
"generalSettingsModifiedKeywordsBoundToPermissionGroups",
"generalSettingsModifiedLegalNoticeText",
"generalSettingsModifiedLegalNoticeURL",
"generalSettingsModifiedMetadataFieldsOrder",
"generalSettingsModifiedPasswordSecurityLevel",
"generalSettingsModifiedSecondAPILimit",
"generalSettingsModifiedSemanticSearch",
"generalSettingsModifiedSessionTimeout",
"generalSettingsModifiedShowChat",
"generalSettingsModifiedShowFileOwner",
"generalSettingsModifiedShowUnimportantMetadataFields",
"generalSettingsModifiedSmartTagging",
"generalSettingsModifiedSubjectExtractionType",
"generalSettingsModifiedSystemLanguage",
"generalSettingsModifiedTextRecognition",
"generalSettingsModifiedTranslationLanguagesAdded",
"generalSettingsModifiedTranslationLanguagesRemoved",
"generalSettingsModifiedTwoFactorAuth",
"generalSettingsModifiedUseAlreadyIncludedKeywords",
"generalSettingsModifiedVideoForceConversion",
"generalSettingsModifiedVideoMaxDuration",
"generalSettingsModifiedVideoMaxSize",
"identityProviderCreated",
"identityProviderDeleted",
"identityProviderModifiedAuthorizationEndpoint",
"identityProviderModifiedClientID",
"identityProviderModifiedClientSecret",
"identityProviderModifiedIsActive",
"identityProviderModifiedMetadataEndpoint",
"identityProviderModifiedName",
"identityProviderModifiedTokenEndpoint",
"identityProviderModifiedUserEndpoint",
"identityProviderModifiedUserField",
"importantMetadataCreated",
"importantMetadataDeleted",
"importantMetadataModifiedIsEditable",
"importantMetadataModifiedIsIndexed",
"importantMetadataModifiedOrder",
"keywordCreated",
"keywordDeleted",
"keywordModifiedPermissionGroupIDsAdded",
"keywordModifiedPermissionGroupIDsRemoved",
"licenseCreated",
"licenseDeleted",
"licenseFileCreated",
"licenseFileDeleted",
"licenseFileModifiedColor",
"licenseFileModifiedCreateDate",
"licenseFileModifiedFile",
"licenseFileModifiedInfosAdded",
"licenseFileModifiedInfosRemoved",
"licenseFileModifiedName",
"licenseFileModifiedShowFile",
"licenseFileModifiedShowWarningMessage",
"licenseFileModifiedWarningMessage",
"licenseModifiedProvider",
"licenseReleaseDataTranslationCreated",
"licenseReleaseDataTranslationModifiedContentName",
"licenseReleaseDataTranslationModifiedContentValue",
"licenseReleaseDataTranslationModifiedLanguage",
"licenseReleaseTranslationCreated",
"licenseReleaseTranslationModifiedLanguage",
"licenseReleaseTranslationModifiedName",
"loginAttempted",
"manageAdministrationServerCreated",
"manageAdministrationServerDeleted",
"manageAdministrationServerModifiedAdministrationServerIdentifier",
"manageAdministrationServerModifiedAllowsPushConnection",
"manageAdministrationServerModifiedName",
"manageAdministrationServerModifiedURL",
"manageBatchTenantIndexedFinished",
"manageBatchTenantIndexedStarted",
"manageFeatureActivated",
"manageFeatureDeactivated",
"manageHostCreated",
"manageHostDeleted",
"manageHostModifiedHostName",
"manageHostModifiedHostType",
"manageHostModifiedIsPortal",
"manageHostModifiedSystemIdentifier",
"managePackageCreated",
"managePackageDeleted",
"managePackageModifiedAvailablePluginsAdded",
"managePackageModifiedAvailablePluginsRemoved",
"managePackageModifiedBookingEnabled",
"managePackageModifiedCustomerValue",
"managePackageModifiedDailyAPILimit",
"managePackageModifiedDiskSpacePerUser",
"managePackageModifiedFeature",
"managePackageModifiedHideAllPackages",
"managePackageModifiedHideCustomerGroupPackages",
"managePackageModifiedHideUniversalPackages",
"managePackageModifiedIncludedDiskspace",
"managePackageModifiedName",
"managePackageModifiedPluginLimit",
"managePackageModifiedSecondAPILimit",
"managePackageModifiedUnlockedCustomerGroupsAdded",
"managePackageModifiedUnlockedCustomerGroupsRemoved",
"managePackageModifiedUnlockedSystemIdentifiersAdded",
"managePackageModifiedUnlockedSystemIdentifiersRemoved",
"managePackageModifiedUnlockedUniversal",
"managePackagePortalCreated",
"managePackagePortalDeleted",
"managePackagePortalFeaturesModified",
"managePackagePortalModifiedName",
"managePluginCreated",
"managePluginDeleted",
"managePluginModifiedApplicationKey",
"managePluginModifiedCustomerIdentifier",
"managePluginModifiedIsActive",
"managePluginModifiedName",
"managePluginModifiedUnlockedUniversal",
"manageServerRecreatedConfig",
"manageServerReloaded",
"manageSystemCreated",
"manageSystemDeleted",
"manageSystemModifiedAdditionalDiskSpaceGigaByte",
"manageSystemModifiedAdministrationServerIdentifier",
"manageSystemModifiedCustomUnlockedFeatures",
"manageSystemModifiedCustomUnlockedFeaturesAdded",
"manageSystemModifiedCustomUnlockedFeaturesRemoved",
"manageSystemModifiedCustomerGroupsAdded",
"manageSystemModifiedCustomerGroupsRemoved",
"manageSystemModifiedCustomerIdentifier",
"manageSystemModifiedDataPath",
"manageSystemModifiedDatabaseAlias",
"manageSystemModifiedDomainName",
"manageSystemModifiedExpirationDate",
"manageSystemModifiedHostName",
"manageSystemModifiedInstallationType",
"manageSystemModifiedIsCurrentlyUpdating",
"manageSystemModifiedIsPaused",
"manageSystemModifiedLastSentMail",
"manageSystemModifiedMediaPortalLimit",
"manageSystemModifiedName",
"manageSystemModifiedOperatingSystem",
"manageSystemModifiedPackageIdentifier",
"manageSystemModifiedPixxioVersion",
"manageSystemModifiedReadOnlyUserLimit",
"manageSystemModifiedReceiveBetaUpdates",
"manageSystemModifiedReceiveUpdates",
"manageSystemModifiedSQLDatabase",
"manageSystemModifiedSQLHost",
"manageSystemModifiedSQLPassword",
"manageSystemModifiedSQLUserName",
"manageSystemModifiedUDID",
"manageSystemModifiedUserLimit",
"manageUnlockedPluginCreated",
"manageUnlockedPluginDeleted",
"manageUnlockedPluginModifiedRedirectURI",
"manageUnlockedPluginModifiedSystemIdentifier",
"messageCenterCreated",
"messageCenterDeleted",
"messageCenterModifiedCollectionsAdded",
"messageCenterModifiedCollectionsRemoved",
"messageCenterModifiedNotificationByApplication",
"messageCenterModifiedNotificationByEmail",
"messageCenterModifiedNotificationDayTime",
"messageCenterModifiedNotificationInterval",
"messageCenterModifiedNotificationMonthDay",
"messageCenterModifiedNotificationWeekDay",
"messageCenterModifiedNotifyCollectionDeleted",
"messageCenterModifiedNotifyCollectionEdited",
"messageCenterModifiedNotifyCollectionMessagingWithoutSubscription",
"messageCenterModifiedNotifyCollectionShared",
"messageCenterModifiedNotifyCollectionSharedInternalWithMe",
"messageCenterModifiedNotifyExternalSharedCollectionOpened",
"metadataFieldCreated",
"metadataFieldDeleted",
"metadataFieldModifiedEditType",
"metadataFieldModifiedIndexedForSearchTerm",
"metadataFieldModifiedIsImportant",
"metadataFieldModifiedIsSearchable",
"metadataFieldModifiedName",
"metadataFieldModifiedSelectionTermsAdded",
"metadataFieldModifiedSelectionTermsRemoved",
"metadataFieldModifiedSelectionTermsRenamed",
"modelCreated",
"modelDeleted",
"modelFileCreated",
"modelFileDeleted",
"modelFileModifiedColor",
"modelFileModifiedCreateDate",
"modelFileModifiedFile",
"modelFileModifiedName",
"modelFileModifiedShowFile",
"modelFileModifiedShowWarningMessage",
"modelFileModifiedWarningMessage",
"modelModifiedBirthDate",
"modelModifiedEmail",
"modelModifiedFirstName",
"modelModifiedLastName",
"modelReleaseTranslationCreated",
"modelReleaseTranslationModifiedLanguage",
"modelReleaseTranslationModifiedName",
"newFileCreated",
"permissionGroupCreated",
"permissionGroupDeleted",
"permissionGroupModifiedCommentFiles",
"permissionGroupModifiedCreateCollections",
"permissionGroupModifiedCreateDirectoriesInHomeDirectory",
"permissionGroupModifiedCreateKeywords",
"permissionGroupModifiedCreatePortals",
"permissionGroupModifiedCreateUploadLinks",
"permissionGroupModifiedDefaultUploadFileState",
"permissionGroupModifiedDeleteForeignCollections",
"permissionGroupModifiedDeleteForeignFiles",
"permissionGroupModifiedDeleteOwnCollections",
"permissionGroupModifiedDeleteOwnFiles",
"permissionGroupModifiedDirectoryIDsToEditAdded",
"permissionGroupModifiedDirectoryIDsToEditAll",
"permissionGroupModifiedDirectoryIDsToEditRemoved",
"permissionGroupModifiedDirectoryIDsToModifyAdded",
"permissionGroupModifiedDirectoryIDsToModifyAll",
"permissionGroupModifiedDirectoryIDsToModifyRemoved",
"permissionGroupModifiedDirectoryIDsToShowAdded",
"permissionGroupModifiedDirectoryIDsToShowAll",
"permissionGroupModifiedDirectoryIDsToShowRemoved",
"permissionGroupModifiedDirectoryIDsToUploadAdded",
"permissionGroupModifiedDirectoryIDsToUploadAll",
"permissionGroupModifiedDirectoryIDsToUploadRemoved",
"permissionGroupModifiedDownloadFormatIDsAdded",
"permissionGroupModifiedDownloadFormatIDsRemoved",
"permissionGroupModifiedEditDesign",
"permissionGroupModifiedEditFilesInHomeDirectory",
"permissionGroupModifiedEditFilesInInternalSharedCollections",
"permissionGroupModifiedEditForeignCollections",
"permissionGroupModifiedEditForeignFiles",
"permissionGroupModifiedEditLicenses",
"permissionGroupModifiedEditUsers",
"permissionGroupModifiedFileStatesToAssignAdded",
"permissionGroupModifiedFileStatesToAssignAll",
"permissionGroupModifiedFileStatesToAssignRemoved",
"permissionGroupModifiedFileStatesToShowAdded",
"permissionGroupModifiedFileStatesToShowAll",
"permissionGroupModifiedFileStatesToShowRemoved",
"permissionGroupModifiedForceDownloadProof",
"permissionGroupModifiedForceExportProof",
"permissionGroupModifiedForceWatermark",
"permissionGroupModifiedHasDownloadFormatFree",
"permissionGroupModifiedHasDownloadFormatOriginal",
"permissionGroupModifiedHasDownloadFormatPreview",
"permissionGroupModifiedIsAdmin",
"permissionGroupModifiedIsExternal",
"permissionGroupModifiedLinked",
"permissionGroupModifiedName",
"permissionGroupModifiedShareCollectionsExternal",
"permissionGroupModifiedShareCollectionsInternal",
"permissionGroupModifiedShareCollectionsNetwork",
"permissionGroupModifiedShareFilesNetwork",
"permissionGroupModifiedShowAllCustomDownloadFormats",
"permissionGroupModifiedUnlinked",
"permissionGroupModifiedUploadFilesToHomeDirectory",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsAdded",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsRemoved",
"permissionGroupModifiedUploadObligationsAdded",
"permissionGroupModifiedUploadObligationsRemoved",
"portalCollectionModifiedIsProtected",
"portalCollectionModifiedOrder",
"portalCreated",
"portalDeleted",
"portalModifiedActivateUserAutomatically",
"portalModifiedAddShadowToFont",
"portalModifiedAutomaticallyActivatedDomainsAdded",
"portalModifiedAutomaticallyActivatedDomainsRemoved",
"portalModifiedBackgroundColor",
"portalModifiedBrandURL",
"portalModifiedBrandingLogoImage",
"portalModifiedCollectionAssetNavigator",
"portalModifiedCollectionsAdded",
"portalModifiedCollectionsRemoved",
"portalModifiedCookieLinkPrivacyPage",
"portalModifiedCookiePlacement",
"portalModifiedCustomMetadataIDsAdded",
"portalModifiedCustomMetadataIDsRemoved",
"portalModifiedDefaultMetadataFieldsAdded",
"portalModifiedDefaultMetadataFieldsRemoved",
"portalModifiedDownloadFormatsAdded",
"portalModifiedDownloadFormatsRemoved",
"portalModifiedEmailReceiver",
"portalModifiedFilterOptionsAdded",
"portalModifiedFilterOptionsRemoved",
"portalModifiedForceDownloadProof",
"portalModifiedForceWatermark",
"portalModifiedGeneralPassword",
"portalModifiedHasUserRegistration",
"portalModifiedHasWhitelabel",
"portalModifiedHeroArrowColor",
"portalModifiedHeroBannerImage",
"portalModifiedHeroFontColor",
"portalModifiedHeroLogoColor",
"portalModifiedHeroLogoImage",
"portalModifiedHostNames",
"portalModifiedIsActive",
"portalModifiedLandingPageOptions",
"portalModifiedLanguagesAdded",
"portalModifiedLanguagesRemoved",
"portalModifiedLicenseReleaseIDsAdded",
"portalModifiedLicenseReleaseIDsRemoved",
"portalModifiedMainHostName",
"portalModifiedMediaViewsAdded",
"portalModifiedMediaViewsRemoved",
"portalModifiedModelReleaseIDsAdded",
"portalModifiedModelReleaseIDsRemoved",
"portalModifiedName",
"portalModifiedOriginalDownloadFormatTypesAdded",
"portalModifiedOriginalDownloadFormatTypesRemoved",
"portalModifiedPageName",
"portalModifiedPagePlacementsAdded",
"portalModifiedPagePlacementsRemoved",
"portalModifiedPageText",
"portalModifiedPageTranslationCreated",
"portalModifiedPageTranslationLanguage",
"portalModifiedPageTranslationName",
"portalModifiedPageTranslationText",
"portalModifiedPagesAdded",
"portalModifiedPagesRemoved",
"portalModifiedPreferredMode",
"portalModifiedPreferredTitle",
"portalModifiedPropertyReleaseIDsAdded",
"portalModifiedPropertyReleaseIDsRemoved",
"portalModifiedProtectedCollectionsAdded",
"portalModifiedProtectedCollectionsRemoved",
"portalModifiedRestrictAccess",
"portalModifiedSearchFieldsAdded",
"portalModifiedSearchFieldsRemoved",
"portalModifiedShowAllLicenseReleases",
"portalModifiedShowAllModelReleases",
"portalModifiedShowAllPropertyReleases",
"portalModifiedShowBorder",
"portalModifiedShowCookieInformation",
"portalModifiedShowCreateLinkToFileTab",
"portalModifiedShowFileType",
"portalModifiedShowLicenseReleaseFile",
"portalModifiedShowModelReleaseFile",
"portalModifiedShowPropertyReleaseFile",
"portalModifiedShowStartScreen",
"portalModifiedSortOptionsAdded",
"portalModifiedSortOptionsRemoved",
"portalModifiedStandardMetadataIDsAdded",
"portalModifiedStandardMetadataIDsRemoved",
"portalModifiedStartScreenText",
"portalModifiedTranslationCookieTextShort",
"portalModifiedTranslationFooterText",
"portalModifiedTranslationHeroSlogan",
"portalModifiedTranslationLanguage",
"portalModifiedUseSSO",
"portalModifiedUseSemanticSearch",
"portalModifiedUserCompany",
"portalModifiedUserDepartment",
"portalModifiedUserEmail",
"portalModifiedUserFirstName",
"portalModifiedUserIsActive",
"portalModifiedUserIsConfirmed",
"portalModifiedUserLanguage",
"portalModifiedUserLastName",
"portalModifiedUserPassword",
"portalModifiedUsersAdded",
"portalModifiedUsersRemoved",
"propertyCreated",
"propertyDeleted",
"propertyFileCreated",
"propertyFileDeleted",
"propertyFileModifiedColor",
"propertyFileModifiedCreateDate",
"propertyFileModifiedFile",
"propertyFileModifiedName",
"propertyFileModifiedShowFile",
"propertyFileModifiedShowWarningMessage",
"propertyFileModifiedWarningMessage",
"propertyModifiedAddress",
"propertyModifiedName",
"propertyModifiedOwner",
"propertyReleaseTranslationCreated",
"propertyReleaseTranslationModifiedLanguage",
"propertyReleaseTranslationModifiedName",
"reportCreated",
"reportDeleted",
"reportModifiedAdditionalText",
"reportModifiedDayInMonth",
"reportModifiedDayInWeek",
"reportModifiedDayTime",
"reportModifiedIsActive",
"reportModifiedName",
"reportModifiedReceiverEmailsAdded",
"reportModifiedReceiverEmailsRemoved",
"reportModifiedReportEventsAdded",
"reportModifiedReportEventsRemoved",
"reportModifiedReportEventsReplaced",
"reportModifiedReportInterval",
"reportModifiedReportWhenNoData",
"reportModifiedSendCSV",
"reportModifiedSendPDF",
"reportUpdated",
"settingsModifiedCustomJavaScript",
"settingsModifiedDateFormat",
"settingsModifiedExternalCollectionSyncHostName",
"settingsModifiedExternalCollectionSyncPassword",
"settingsModifiedExternalCollectionSyncUserName",
"settingsModifiedExternalCustomCss",
"settingsModifiedExternalShareHostName",
"settingsModifiedExternalSharePassword",
"settingsModifiedExternalShareUserName",
"settingsModifiedFaviconFile",
"settingsModifiedFaviconText",
"settingsModifiedFont",
"settingsModifiedLogoBigDark",
"settingsModifiedLogoBigLight",
"settingsModifiedLogoBootFile",
"settingsModifiedLogoDarkFile",
"settingsModifiedLogoFile",
"settingsModifiedLogoIconDark",
"settingsModifiedLogoIconLight",
"settingsModifiedLogoLink",
"settingsModifiedPrimaryColorDark",
"settingsModifiedPrimaryColorLight",
"settingsModifiedProxyHostName",
"settingsModifiedProxyPort",
"settingsModifiedSMTPHasSSL",
"settingsModifiedSMTPHostName",
"settingsModifiedSMTPPassword",
"settingsModifiedSMTPPort",
"settingsModifiedSMTPTransmitterEmail",
"settingsModifiedSMTPTransmitterName",
"settingsModifiedSMTPUseDefault",
"settingsModifiedSMTPUserName",
"settingsModifiedSecondaryColorDark",
"settingsModifiedSecondaryColorLight",
"settingsModifiedSloganStartscreen",
"settingsModifiedStartscreenFile",
"settingsModifiedUploadLinkBackgroundFile",
"settingsModifiedWatermarkFile",
"settingsModifiedWatermarkPositionIsBottomLeft",
"settingsModifiedWatermarkPositionIsBottomMiddle",
"settingsModifiedWatermarkPositionIsBottomRight",
"settingsModifiedWatermarkPositionIsCenter",
"settingsModifiedWatermarkPositionIsMiddleLeft",
"settingsModifiedWatermarkPositionIsMiddleRight",
"settingsModifiedWatermarkPositionIsUpperLeft",
"settingsModifiedWatermarkPositionIsUpperMiddle",
"settingsModifiedWatermarkPositionIsUpperRight",
"settingsModifiedWatermarkPositioningType",
"settingsModifiedWatermarkText",
"settingsModifiedWatermarkTransparency",
"settingsModifiedWatermarkWidthPercent",
"spaceCreated",
"spaceDeleted",
"spaceModifiedAutomaticallyActivatedDomainsAdded",
"spaceModifiedAutomaticallyActivatedDomainsRemoved",
"spaceModifiedCopyrightText",
"spaceModifiedCustomBodyFontFileID",
"spaceModifiedCustomHeadingsFontFileID",
"spaceModifiedCustomMetadataIDs",
"spaceModifiedCustomization",
"spaceModifiedDefaultMetadataFields",
"spaceModifiedDownloadFormatIDsAdded",
"spaceModifiedDownloadFormatIDsRemoved",
"spaceModifiedFaviconImage",
"spaceModifiedForceDownloadProof",
"spaceModifiedForceWatermark",
"spaceModifiedHostNames",
"spaceModifiedIsActive",
"spaceModifiedLanguagesAdded",
"spaceModifiedLanguagesRemoved",
"spaceModifiedLicenseReleaseIDs",
"spaceModifiedLoginBackgroundImage",
"spaceModifiedLoginHeadline",
"spaceModifiedLoginRequired",
"spaceModifiedLogoDarkImage",
"spaceModifiedLogoLightImage",
"spaceModifiedMainHostName",
"spaceModifiedModelReleaseIDs",
"spaceModifiedName",
"spaceModifiedNavigationFooter",
"spaceModifiedNavigationHeader",
"spaceModifiedOriginalDownloadFormatTypesAdded",
"spaceModifiedOriginalDownloadFormatTypesRemoved",
"spaceModifiedPermissionGroupIDsAdded",
"spaceModifiedPermissionGroupIDsRemoved",
"spaceModifiedPermissionGroupsAdded",
"spaceModifiedPermissionGroupsRemoved",
"spaceModifiedPreferredTitle",
"spaceModifiedPrimaryColor",
"spaceModifiedPropertyReleaseIDs",
"spaceModifiedSearchFieldsAdded",
"spaceModifiedSearchFieldsRemoved",
"spaceModifiedSecondaryColor",
"spaceModifiedShowAllLicenseReleases",
"spaceModifiedShowAllModelReleases",
"spaceModifiedShowAllPropertyReleases",
"spaceModifiedShowFileType",
"spaceModifiedShowLicenseReleaseFile",
"spaceModifiedShowModelReleaseFile",
"spaceModifiedShowPropertyReleaseFile",
"spaceModifiedShowTermsOfUse",
"spaceModifiedStandardMetadataIDs",
"spaceModifiedStartScreenPage",
"spaceModifiedTermsOfUse",
"spaceModifiedUseSSO",
"spaceModifiedUseSemanticSearch",
"spaceNavigationFooterCreated",
"spaceNavigationFooterDeleted",
"spaceNavigationFooterLinkCreated",
"spaceNavigationFooterLinkDeleted",
"spaceNavigationFooterLinkTranslationCreated",
"spaceNavigationFooterTranslationCreated",
"spaceNavigationHeaderCategoryCreated",
"spaceNavigationHeaderCategoryDeleted",
"spaceNavigationHeaderCategoryTranslationCreated",
"spaceNavigationHeaderCreated",
"spaceNavigationHeaderDeleted",
"spaceNavigationHeaderTranslationCreated",
"spaceNavigationModifiedAnchor",
"spaceNavigationModifiedFooterFooterText",
"spaceNavigationModifiedFooterLinkName",
"spaceNavigationModifiedFooterLinkOrder",
"spaceNavigationModifiedFooterName",
"spaceNavigationModifiedFooterOrder",
"spaceNavigationModifiedHeaderCategoryName",
"spaceNavigationModifiedHeaderCategoryOrder",
"spaceNavigationModifiedHeaderName",
"spaceNavigationModifiedHeaderOrder",
"spaceNavigationModifiedLink",
"spaceNavigationModifiedSpacePageID",
"spacePageCreated",
"spacePageDeleted",
"spacePageModifiedContent",
"spacePageModifiedName",
"spacePageModifiedSlug",
"spacePageTemplateCreated",
"spacePageTemplateDeleted",
"spacePageTemplateUpdated",
"spacePageTranslationCreated",
"spaceTemplateCreated",
"spaceTemplateDeleted",
"spaceTemplateUpdated",
"standardMetadataCreated",
"standardMetadataDeleted",
"standardMetadataModifiedValue",
"standardMetadataModifiedValueType",
"synonymColumnsModifiedSynonym1",
"synonymColumnsModifiedSynonym10",
"synonymColumnsModifiedSynonym11",
"synonymColumnsModifiedSynonym12",
"synonymColumnsModifiedSynonym13",
"synonymColumnsModifiedSynonym14",
"synonymColumnsModifiedSynonym15",
"synonymColumnsModifiedSynonym16",
"synonymColumnsModifiedSynonym17",
"synonymColumnsModifiedSynonym18",
"synonymColumnsModifiedSynonym19",
"synonymColumnsModifiedSynonym2",
"synonymColumnsModifiedSynonym20",
"synonymColumnsModifiedSynonym3",
"synonymColumnsModifiedSynonym4",
"synonymColumnsModifiedSynonym5",
"synonymColumnsModifiedSynonym6",
"synonymColumnsModifiedSynonym7",
"synonymColumnsModifiedSynonym8",
"synonymColumnsModifiedSynonym9",
"synonymCreated",
"synonymDeleted",
"synonymModifiedSynonym",
"tenantModifiedAdditionalDiskSpaceGigaByte",
"tenantModifiedCustomUnlockedFeatures",
"tenantModifiedCustomUnlockedFeaturesAdded",
"tenantModifiedCustomUnlockedFeaturesRemoved",
"tenantModifiedExpirationDate",
"tenantModifiedMediaPortalLimit",
"tenantModifiedPackageIdentifier",
"tenantModifiedReadOnlyUserLimit",
"tenantModifiedUserLimit",
"trashCreated",
"trashDeleted",
"trashFileIDsRestored",
"uploadLinkCreated",
"uploadLinkDeleted",
"uploadLinkFileUploaded",
"uploadLinkModifiedDescription",
"uploadLinkModifiedDirectoryID",
"uploadLinkModifiedEmailsAdded",
"uploadLinkModifiedFaceRecognitionDisabled",
"uploadLinkModifiedFileStateID",
"uploadLinkModifiedFilesAdded",
"uploadLinkModifiedFilesRemoved",
"uploadLinkModifiedIsDisabled",
"uploadLinkModifiedKeywordsAdded",
"uploadLinkModifiedKeywordsRemoved",
"uploadLinkModifiedLicenseReleaseIDsAdded",
"uploadLinkModifiedLicenseReleaseIDsRemoved",
"uploadLinkModifiedModelReleaseIDsAdded",
"uploadLinkModifiedModelReleaseIDsRemoved",
"uploadLinkModifiedName",
"uploadLinkModifiedNotificationText",
"uploadLinkModifiedPropertyReleaseIDsAdded",
"uploadLinkModifiedPropertyReleaseIDsRemoved",
"uploadLinkModifiedShowAllLicenseReleases",
"uploadLinkModifiedShowAllModelReleases",
"uploadLinkModifiedShowAllPropertyReleases",
"uploadLinkModifiedUploadCondition",
"uploadLinkModifiedUserID",
"uploadLinkModifiedValidityPeriod",
"userCreated",
"userDeleted",
"userModifiedCIFSPassword",
"userModifiedEmail",
"userModifiedFirstName",
"userModifiedIsActive",
"userModifiedIsExternal",
"userModifiedLanguage",
"userModifiedLastName",
"userModifiedLinked",
"userModifiedPassword",
"userModifiedPermissionGroupIDsAdded",
"userModifiedPermissionGroupIDsRemoved",
"userModifiedRefreshToken",
"userModifiedResetPasswordStamp",
"userModifiedResetPasswordToken",
"userModifiedSecret",
"userModifiedSecretExpirationDate",
"userModifiedTwoFactorAuthSetUp",
"userModifiedUnlinked",
"userModifiedUserName",
"userTrackingCreated",
"userTrackingDeleted",
"userTrackingModifiedFirstMonthlyLogin",
"userTrackingModifiedUserID",
"variantStackCreated",
"variantStackDeleted",
"variantStackModifiedDescription",
"variantStackModifiedFilesAdded",
"variantStackModifiedFilesRemoved",
"variantStackModifiedName",
"webhookCreated",
"webhookDeleted",
"webhookModifiedDescription",
"webhookModifiedEventKey",
"webhookModifiedEventKeysAdded",
"webhookModifiedEventKeysRemoved",
"webhookModifiedName",
"webhookModifiedSecret",
"webhookModifiedURL"
],
"example": "fileCreated",
"title": "EventKey",
"type": "string"
},
"type": "array"
},
"ArraySchema_3266363436": {
"description": "The removed selectionTerms.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3266373361": {
"description": "The removed keywords.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3330303934": {
"description": "The deleted metadataFieldLanguages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3334343039": {
"description": "The removed mediaViews.",
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"type": "array"
},
"ArraySchema_3335306239": {
"description": "The ids of the deleted files.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_3336323038": {
"description": "The removed collections.",
"items": {
"$ref": "#/components/schemas/CollectionInfo"
},
"type": "array"
},
"ArraySchema_3336323230": {
"description": "The added unlockedSystemIdentifiers.",
"items": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"type": "array"
},
"ArraySchema_3337663130": {
"description": "The deleted metadataFieldMultiSelections.",
"items": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3732363832"
},
"type": "array"
},
"ArraySchema_3364303330": {
"description": "The removed defaultLanguageCodes.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3364393438": {
"description": "The added downloadFormatIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3430336163": {
"description": "The added externalShareIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3434343239": {
"description": "The removed downloadFormats.",
"items": {
"$ref": "#/components/schemas/DownloadFormatInfo"
},
"type": "array"
},
"ArraySchema_3434363736": {
"description": "The old ValueCustomFieldsOptionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3435316466": {
"description": "The removed users.",
"items": {
"$ref": "#/components/schemas/UserInfo_6263373834"
},
"type": "array"
},
"ArraySchema_3438306535": {
"description": "The new ValueCustomFieldsOptionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3438326230": {
"description": "The added licenseReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3438636236": {
"description": "The added permissionGroups.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3439356330": {
"description": "The added translationLanguages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3463653235": {
"description": "The added infos.",
"items": {
"$ref": "#/components/schemas/LicenseData"
},
"type": "array"
},
"ArraySchema_3464306138": {
"description": "The spacePageTemplates that were assigned to this spaceTemplate.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3464386466": {
"description": "The added downloadFormats.",
"items": {
"$ref": "#/components/schemas/DownloadFormatInfo"
},
"type": "array"
},
"ArraySchema_3466613063": {
"description": "The added sortOptions.",
"items": {
"description": "A sort type.",
"enum": [
"createDate",
"fileName",
"subject",
"uploadDate"
],
"example": "uploadDate",
"title": "SortType",
"type": "string"
},
"type": "array"
},
"ArraySchema_3530643134": {
"description": "The added mediaViews.",
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"type": "array"
},
"ArraySchema_3534653430": {
"description": "The removed externalShareIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3535396365": {
"description": "The removed directoryIDsToCreate.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3539653435": {
"description": "The removed permissionGroupIDs.",
"items": {
"$ref": "#/components/schemas/PermissionGroupInfo"
},
"type": "array"
},
"ArraySchema_3561636530": {
"description": "The removed originalDownloadFormatTypes.",
"items": {
"description": "FormatType is an Entity for a FormatType. A FormatType describes a set of FileBasic Extensions, the Web FormatType for example consists of the FileBasic Extensions JPG, JPEG, GIF and PNG.",
"enum": [
"archive",
"audio",
"converted",
"image",
"imageconverted",
"office",
"other",
"pdf",
"raw",
"raw-image",
"vector",
"video",
"web",
"web-image",
"webimage"
],
"example": "web",
"title": "FormatType",
"type": "string"
},
"type": "array"
},
"ArraySchema_3563633032": {
"description": "The added collections.",
"items": {
"$ref": "#/components/schemas/CollectionInfo"
},
"type": "array"
},
"ArraySchema_3563633061": {
"description": "The IDs of the standard metadata that were removed.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3566303534": {
"description": "The IDs of the custom metadata that were removed.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3633623139": {
"description": "The removed availablePlugins.",
"items": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"type": "array"
},
"ArraySchema_3633656531": {
"description": "The added metadataFieldLanguages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3634383538": {
"description": "The files which have been removed.",
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
"ArraySchema_3635653962": {
"description": "The downloadURL of the downloaded files.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_3637313131": {
"description": "The added directoryIDsToShow.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3637333961": {
"description": "The added keywordsRecognition.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3638366332": {
"description": "The added eventKeys.",
"items": {
"description": "EventKey represents the key of an event.",
"enum": [
"apiKeyCreated",
"apiKeyDeleted",
"apiKeyModifiedIPRangeAdded",
"apiKeyModifiedIPRangeRemoved",
"apiKeyModifiedIsActive",
"apiKeyModifiedName",
"apiKeyModifiedScopeID",
"apiKeyModifiedUserID",
"assetNavigatorCategoryCreated",
"assetNavigatorCategoryDeleted",
"assetNavigatorCategoryModifiedMetadataFieldID",
"assetNavigatorCategoryModifiedOrder",
"assetNavigatorCategoryTranslationCreated",
"assetNavigatorCategoryTranslationModifiedLanguage",
"assetNavigatorCategoryTranslationModifiedName",
"assetNavigatorCreated",
"assetNavigatorDeleted",
"assetNavigatorModifiedAssetNavigatorCategory",
"assetNavigatorModifiedDescription",
"assetNavigatorModifiedName",
"azureActiveDirectoryCreated",
"azureActiveDirectoryDeleted",
"azureActiveDirectoryModifiedClientID",
"azureActiveDirectoryModifiedClientSecret",
"azureActiveDirectoryModifiedDeleteMode",
"azureActiveDirectoryModifiedGroupUpdated",
"azureActiveDirectoryModifiedGroupsActivated",
"azureActiveDirectoryModifiedGroupsAdded",
"azureActiveDirectoryModifiedGroupsDeactivated",
"azureActiveDirectoryModifiedGroupsRemoved",
"azureActiveDirectoryModifiedIPRangeAdded",
"azureActiveDirectoryModifiedIPRangeRemoved",
"azureActiveDirectoryModifiedName",
"azureActiveDirectoryModifiedNewUserDataOwner",
"azureActiveDirectoryModifiedRecursive",
"azureActiveDirectoryModifiedSyncTime",
"azureActiveDirectoryModifiedTenantID",
"collectionCreated",
"collectionDeleted",
"collectionModifiedAssetNavigatorID",
"collectionModifiedFilesAdded",
"collectionModifiedFilesCommented",
"collectionModifiedFilesRemoved",
"collectionModifiedPreviewFileIDs",
"collectionModifiedUserID",
"collectionSharedExternally",
"collectionSharedInternally",
"collectionTranslationCreated",
"collectionTranslationDeleted",
"collectionTranslationModifiedDescription",
"collectionTranslationModifiedLanguage",
"collectionTranslationModifiedName",
"collectionUnsharedInternally",
"commentCreated",
"commentDeleted",
"customMetadataCreated",
"customMetadataDeleted",
"customMetadataLanguagesCreated",
"customMetadataLanguagesDeleted",
"customMetadataLanguagesModifiedName",
"customMetadataModifiedParentConditionCustomMetadataID",
"customMetadataModifiedParentConditionCustomMetadataOptionIDs",
"customMetadataOptionLanguagesCreated",
"customMetadataOptionLanguagesDeleted",
"customMetadataOptionLanguagesModifiedName",
"customMetadataOptionsCreated",
"customMetadataOptionsDeleted",
"customMetadataOptionsModifiedOrder",
"customMetadataParentConditionCreated",
"customMetadataParentConditionDeleted",
"directLinkCreated",
"directLinkDeleted",
"directLinkModifiedDownloadFormatID",
"directLinkModifiedFileID",
"directLinkModifiedFileName",
"directLinkModifiedFileSize",
"directoryCreated",
"directoryDeleted",
"directoryModifiedName",
"directoryModifiedParentDirectoryID",
"downloadCreated",
"downloadDeleted",
"downloadFormatCreated",
"downloadFormatDeleted",
"downloadFormatModifiedColorspace",
"downloadFormatModifiedDensity",
"downloadFormatModifiedFormatConversion",
"downloadFormatModifiedHeight",
"downloadFormatModifiedName",
"downloadFormatModifiedQuality",
"downloadFormatModifiedResize",
"downloadFormatModifiedResizeUnit",
"downloadFormatModifiedWidth",
"downloadFormatTranslationCreated",
"downloadFormatTranslationModifiedLanguage",
"downloadFormatTranslationModifiedName",
"downloadModifiedDownloadFormatID",
"downloadModifiedFileIDsAdded",
"downloadModifiedFileIDsRemoved",
"downloadModifiedUserID",
"downloadModifiedUserName",
"duplicateFileCreated",
"duplicateFileDeleted",
"emailCustomTemplateCreated",
"emailCustomTemplateDeleted",
"emailCustomTemplateModifiedBody",
"emailCustomTemplateModifiedLanguage",
"emailCustomTemplateModifiedName",
"emailCustomTemplateModifiedSubject",
"emailCustomTemplateModifiedType",
"externalShareCreated",
"externalShareDeleted",
"externalShareModifiedAllowComments",
"externalShareModifiedAllowDownloads",
"externalShareModifiedAllowUpvotes",
"externalShareModifiedDescription",
"externalShareModifiedDownloadFormatsAdded",
"externalShareModifiedDownloadFormatsRemoved",
"externalShareModifiedEmailsAdded",
"externalShareModifiedFileDetailsAdded",
"externalShareModifiedFileDetailsRemoved",
"externalShareModifiedFilesAdded",
"externalShareModifiedFilesRemoved",
"externalShareModifiedForceDownloadProof",
"externalShareModifiedForceWatermark",
"externalShareModifiedHasDownloadFormatFree",
"externalShareModifiedHasDownloadFormatOriginal",
"externalShareModifiedHasDownloadFormatPreview",
"externalShareModifiedIsDisabled",
"externalShareModifiedMediaViewsAdded",
"externalShareModifiedMediaViewsRemoved",
"externalShareModifiedName",
"externalShareModifiedNotificationText",
"externalShareModifiedPassword",
"externalShareModifiedTermsOfUse",
"externalShareModifiedUserID",
"externalShareModifiedValidityPeriod",
"externalShareViewed",
"externalSharesCommentCreated",
"externalSharesCommentDeleted",
"externalSharesUpvoteCreated",
"externalSharesUpvoteDeleted",
"fileCreated",
"fileDeleted",
"fileDeletedDuplicate",
"fileDownloaded",
"fileModifiedCollectionIDsAdded",
"fileModifiedCollectionIDsRemoved",
"fileModifiedCreateDate",
"fileModifiedCreator",
"fileModifiedDescription",
"fileModifiedDirectoryIDPath",
"fileModifiedExternalShareIDsAdded",
"fileModifiedExternalShareIDsRemoved",
"fileModifiedFaces",
"fileModifiedFileName",
"fileModifiedFileStateID",
"fileModifiedIsCheckedOut",
"fileModifiedIsDownloadLocked",
"fileModifiedKeywordsAdded",
"fileModifiedKeywordsDeleted",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedLanguageCodesAdded",
"fileModifiedLanguageCodesRemoved",
"fileModifiedLicenseFilesAdded",
"fileModifiedLicenseFilesDeleted",
"fileModifiedLocation",
"fileModifiedMainVersionFileID",
"fileModifiedMarkedUserIDsAdded",
"fileModifiedMarkedUserIDsRemoved",
"fileModifiedMetadataFieldDate",
"fileModifiedMetadataFieldFocalPoint",
"fileModifiedMetadataFieldLanguagesAdded",
"fileModifiedMetadataFieldLanguagesDeleted",
"fileModifiedMetadataFieldLocation",
"fileModifiedMetadataFieldMultiSelectionsAdded",
"fileModifiedMetadataFieldMultiSelectionsDeleted",
"fileModifiedMetadataFieldOrientation",
"fileModifiedMetadataFieldSelection",
"fileModifiedMetadataFieldText",
"fileModifiedMetadataFieldTruncate",
"fileModifiedModelFilesAdded",
"fileModifiedModelFilesDeleted",
"fileModifiedPropertyFilesAdded",
"fileModifiedPropertyFilesDeleted",
"fileModifiedRating",
"fileModifiedRecognizedText",
"fileModifiedRotation",
"fileModifiedSubject",
"fileModifiedUploadDate",
"fileModifiedUploadLink",
"fileModifiedUserID",
"fileModifiedVariantStack",
"fileReplaced",
"fileReplacedPreviewFile",
"fileRestoredPreviewFile",
"fileStateCreated",
"fileStateDeleted",
"fileStateModifiedColor",
"fileStateModifiedDescription",
"fileStateModifiedForceComment",
"fileStateModifiedIsArchive",
"fileStateModifiedName",
"fileStateModifiedOrder",
"filesCustomFieldCreated",
"filesCustomFieldDeleted",
"filesCustomFieldModifiedValue",
"filesCustomFieldModifiedValueCustomFieldsOptionID",
"filesCustomFieldModifiedValueCustomFieldsOptionIDs",
"filterCreated",
"filterDeleted",
"filterModifiedFilter",
"filterModifiedName",
"filterModifiedUserID",
"generalSettingsModifiedAllowConcurrentLogin",
"generalSettingsModifiedAllowDuplicates",
"generalSettingsModifiedCheckSessionFiles",
"generalSettingsModifiedDailyAPILimit",
"generalSettingsModifiedDataPrivacyText",
"generalSettingsModifiedDataPrivacyURL",
"generalSettingsModifiedDefaultLanguageCodesAdded",
"generalSettingsModifiedDefaultLanguageCodesRemoved",
"generalSettingsModifiedDirectoriesInMediaview",
"generalSettingsModifiedDownloadCacheSize",
"generalSettingsModifiedDownloadCacheStoreCroppedFiles",
"generalSettingsModifiedDownloadCacheTime",
"generalSettingsModifiedDownloadLockedText",
"generalSettingsModifiedEnableForgotPasswordOption",
"generalSettingsModifiedExternalShareAlias",
"generalSettingsModifiedFaceRecognition",
"generalSettingsModifiedGeneralUploadText",
"generalSettingsModifiedKeywordUploadText",
"generalSettingsModifiedKeywordsBoundToPermissionGroups",
"generalSettingsModifiedLegalNoticeText",
"generalSettingsModifiedLegalNoticeURL",
"generalSettingsModifiedMetadataFieldsOrder",
"generalSettingsModifiedPasswordSecurityLevel",
"generalSettingsModifiedSecondAPILimit",
"generalSettingsModifiedSemanticSearch",
"generalSettingsModifiedSessionTimeout",
"generalSettingsModifiedShowChat",
"generalSettingsModifiedShowFileOwner",
"generalSettingsModifiedShowUnimportantMetadataFields",
"generalSettingsModifiedSmartTagging",
"generalSettingsModifiedSubjectExtractionType",
"generalSettingsModifiedSystemLanguage",
"generalSettingsModifiedTextRecognition",
"generalSettingsModifiedTranslationLanguagesAdded",
"generalSettingsModifiedTranslationLanguagesRemoved",
"generalSettingsModifiedTwoFactorAuth",
"generalSettingsModifiedUseAlreadyIncludedKeywords",
"generalSettingsModifiedVideoForceConversion",
"generalSettingsModifiedVideoMaxDuration",
"generalSettingsModifiedVideoMaxSize",
"identityProviderCreated",
"identityProviderDeleted",
"identityProviderModifiedAuthorizationEndpoint",
"identityProviderModifiedClientID",
"identityProviderModifiedClientSecret",
"identityProviderModifiedIsActive",
"identityProviderModifiedMetadataEndpoint",
"identityProviderModifiedName",
"identityProviderModifiedTokenEndpoint",
"identityProviderModifiedUserEndpoint",
"identityProviderModifiedUserField",
"importantMetadataCreated",
"importantMetadataDeleted",
"importantMetadataModifiedIsEditable",
"importantMetadataModifiedIsIndexed",
"importantMetadataModifiedOrder",
"keywordCreated",
"keywordDeleted",
"keywordModifiedPermissionGroupIDsAdded",
"keywordModifiedPermissionGroupIDsRemoved",
"licenseCreated",
"licenseDeleted",
"licenseFileCreated",
"licenseFileDeleted",
"licenseFileModifiedColor",
"licenseFileModifiedCreateDate",
"licenseFileModifiedFile",
"licenseFileModifiedInfosAdded",
"licenseFileModifiedInfosRemoved",
"licenseFileModifiedName",
"licenseFileModifiedShowFile",
"licenseFileModifiedShowWarningMessage",
"licenseFileModifiedWarningMessage",
"licenseModifiedProvider",
"licenseReleaseDataTranslationCreated",
"licenseReleaseDataTranslationModifiedContentName",
"licenseReleaseDataTranslationModifiedContentValue",
"licenseReleaseDataTranslationModifiedLanguage",
"licenseReleaseTranslationCreated",
"licenseReleaseTranslationModifiedLanguage",
"licenseReleaseTranslationModifiedName",
"loginAttempted",
"manageAdministrationServerCreated",
"manageAdministrationServerDeleted",
"manageAdministrationServerModifiedAdministrationServerIdentifier",
"manageAdministrationServerModifiedAllowsPushConnection",
"manageAdministrationServerModifiedName",
"manageAdministrationServerModifiedURL",
"manageBatchTenantIndexedFinished",
"manageBatchTenantIndexedStarted",
"manageFeatureActivated",
"manageFeatureDeactivated",
"manageHostCreated",
"manageHostDeleted",
"manageHostModifiedHostName",
"manageHostModifiedHostType",
"manageHostModifiedIsPortal",
"manageHostModifiedSystemIdentifier",
"managePackageCreated",
"managePackageDeleted",
"managePackageModifiedAvailablePluginsAdded",
"managePackageModifiedAvailablePluginsRemoved",
"managePackageModifiedBookingEnabled",
"managePackageModifiedCustomerValue",
"managePackageModifiedDailyAPILimit",
"managePackageModifiedDiskSpacePerUser",
"managePackageModifiedFeature",
"managePackageModifiedHideAllPackages",
"managePackageModifiedHideCustomerGroupPackages",
"managePackageModifiedHideUniversalPackages",
"managePackageModifiedIncludedDiskspace",
"managePackageModifiedName",
"managePackageModifiedPluginLimit",
"managePackageModifiedSecondAPILimit",
"managePackageModifiedUnlockedCustomerGroupsAdded",
"managePackageModifiedUnlockedCustomerGroupsRemoved",
"managePackageModifiedUnlockedSystemIdentifiersAdded",
"managePackageModifiedUnlockedSystemIdentifiersRemoved",
"managePackageModifiedUnlockedUniversal",
"managePackagePortalCreated",
"managePackagePortalDeleted",
"managePackagePortalFeaturesModified",
"managePackagePortalModifiedName",
"managePluginCreated",
"managePluginDeleted",
"managePluginModifiedApplicationKey",
"managePluginModifiedCustomerIdentifier",
"managePluginModifiedIsActive",
"managePluginModifiedName",
"managePluginModifiedUnlockedUniversal",
"manageServerRecreatedConfig",
"manageServerReloaded",
"manageSystemCreated",
"manageSystemDeleted",
"manageSystemModifiedAdditionalDiskSpaceGigaByte",
"manageSystemModifiedAdministrationServerIdentifier",
"manageSystemModifiedCustomUnlockedFeatures",
"manageSystemModifiedCustomUnlockedFeaturesAdded",
"manageSystemModifiedCustomUnlockedFeaturesRemoved",
"manageSystemModifiedCustomerGroupsAdded",
"manageSystemModifiedCustomerGroupsRemoved",
"manageSystemModifiedCustomerIdentifier",
"manageSystemModifiedDataPath",
"manageSystemModifiedDatabaseAlias",
"manageSystemModifiedDomainName",
"manageSystemModifiedExpirationDate",
"manageSystemModifiedHostName",
"manageSystemModifiedInstallationType",
"manageSystemModifiedIsCurrentlyUpdating",
"manageSystemModifiedIsPaused",
"manageSystemModifiedLastSentMail",
"manageSystemModifiedMediaPortalLimit",
"manageSystemModifiedName",
"manageSystemModifiedOperatingSystem",
"manageSystemModifiedPackageIdentifier",
"manageSystemModifiedPixxioVersion",
"manageSystemModifiedReadOnlyUserLimit",
"manageSystemModifiedReceiveBetaUpdates",
"manageSystemModifiedReceiveUpdates",
"manageSystemModifiedSQLDatabase",
"manageSystemModifiedSQLHost",
"manageSystemModifiedSQLPassword",
"manageSystemModifiedSQLUserName",
"manageSystemModifiedUDID",
"manageSystemModifiedUserLimit",
"manageUnlockedPluginCreated",
"manageUnlockedPluginDeleted",
"manageUnlockedPluginModifiedRedirectURI",
"manageUnlockedPluginModifiedSystemIdentifier",
"messageCenterCreated",
"messageCenterDeleted",
"messageCenterModifiedCollectionsAdded",
"messageCenterModifiedCollectionsRemoved",
"messageCenterModifiedNotificationByApplication",
"messageCenterModifiedNotificationByEmail",
"messageCenterModifiedNotificationDayTime",
"messageCenterModifiedNotificationInterval",
"messageCenterModifiedNotificationMonthDay",
"messageCenterModifiedNotificationWeekDay",
"messageCenterModifiedNotifyCollectionDeleted",
"messageCenterModifiedNotifyCollectionEdited",
"messageCenterModifiedNotifyCollectionMessagingWithoutSubscription",
"messageCenterModifiedNotifyCollectionShared",
"messageCenterModifiedNotifyCollectionSharedInternalWithMe",
"messageCenterModifiedNotifyExternalSharedCollectionOpened",
"metadataFieldCreated",
"metadataFieldDeleted",
"metadataFieldModifiedEditType",
"metadataFieldModifiedIndexedForSearchTerm",
"metadataFieldModifiedIsImportant",
"metadataFieldModifiedIsSearchable",
"metadataFieldModifiedName",
"metadataFieldModifiedSelectionTermsAdded",
"metadataFieldModifiedSelectionTermsRemoved",
"metadataFieldModifiedSelectionTermsRenamed",
"modelCreated",
"modelDeleted",
"modelFileCreated",
"modelFileDeleted",
"modelFileModifiedColor",
"modelFileModifiedCreateDate",
"modelFileModifiedFile",
"modelFileModifiedName",
"modelFileModifiedShowFile",
"modelFileModifiedShowWarningMessage",
"modelFileModifiedWarningMessage",
"modelModifiedBirthDate",
"modelModifiedEmail",
"modelModifiedFirstName",
"modelModifiedLastName",
"modelReleaseTranslationCreated",
"modelReleaseTranslationModifiedLanguage",
"modelReleaseTranslationModifiedName",
"newFileCreated",
"permissionGroupCreated",
"permissionGroupDeleted",
"permissionGroupModifiedCommentFiles",
"permissionGroupModifiedCreateCollections",
"permissionGroupModifiedCreateDirectoriesInHomeDirectory",
"permissionGroupModifiedCreateKeywords",
"permissionGroupModifiedCreatePortals",
"permissionGroupModifiedCreateUploadLinks",
"permissionGroupModifiedDefaultUploadFileState",
"permissionGroupModifiedDeleteForeignCollections",
"permissionGroupModifiedDeleteForeignFiles",
"permissionGroupModifiedDeleteOwnCollections",
"permissionGroupModifiedDeleteOwnFiles",
"permissionGroupModifiedDirectoryIDsToEditAdded",
"permissionGroupModifiedDirectoryIDsToEditAll",
"permissionGroupModifiedDirectoryIDsToEditRemoved",
"permissionGroupModifiedDirectoryIDsToModifyAdded",
"permissionGroupModifiedDirectoryIDsToModifyAll",
"permissionGroupModifiedDirectoryIDsToModifyRemoved",
"permissionGroupModifiedDirectoryIDsToShowAdded",
"permissionGroupModifiedDirectoryIDsToShowAll",
"permissionGroupModifiedDirectoryIDsToShowRemoved",
"permissionGroupModifiedDirectoryIDsToUploadAdded",
"permissionGroupModifiedDirectoryIDsToUploadAll",
"permissionGroupModifiedDirectoryIDsToUploadRemoved",
"permissionGroupModifiedDownloadFormatIDsAdded",
"permissionGroupModifiedDownloadFormatIDsRemoved",
"permissionGroupModifiedEditDesign",
"permissionGroupModifiedEditFilesInHomeDirectory",
"permissionGroupModifiedEditFilesInInternalSharedCollections",
"permissionGroupModifiedEditForeignCollections",
"permissionGroupModifiedEditForeignFiles",
"permissionGroupModifiedEditLicenses",
"permissionGroupModifiedEditUsers",
"permissionGroupModifiedFileStatesToAssignAdded",
"permissionGroupModifiedFileStatesToAssignAll",
"permissionGroupModifiedFileStatesToAssignRemoved",
"permissionGroupModifiedFileStatesToShowAdded",
"permissionGroupModifiedFileStatesToShowAll",
"permissionGroupModifiedFileStatesToShowRemoved",
"permissionGroupModifiedForceDownloadProof",
"permissionGroupModifiedForceExportProof",
"permissionGroupModifiedForceWatermark",
"permissionGroupModifiedHasDownloadFormatFree",
"permissionGroupModifiedHasDownloadFormatOriginal",
"permissionGroupModifiedHasDownloadFormatPreview",
"permissionGroupModifiedIsAdmin",
"permissionGroupModifiedIsExternal",
"permissionGroupModifiedLinked",
"permissionGroupModifiedName",
"permissionGroupModifiedShareCollectionsExternal",
"permissionGroupModifiedShareCollectionsInternal",
"permissionGroupModifiedShareCollectionsNetwork",
"permissionGroupModifiedShareFilesNetwork",
"permissionGroupModifiedShowAllCustomDownloadFormats",
"permissionGroupModifiedUnlinked",
"permissionGroupModifiedUploadFilesToHomeDirectory",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsAdded",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsRemoved",
"permissionGroupModifiedUploadObligationsAdded",
"permissionGroupModifiedUploadObligationsRemoved",
"portalCollectionModifiedIsProtected",
"portalCollectionModifiedOrder",
"portalCreated",
"portalDeleted",
"portalModifiedActivateUserAutomatically",
"portalModifiedAddShadowToFont",
"portalModifiedAutomaticallyActivatedDomainsAdded",
"portalModifiedAutomaticallyActivatedDomainsRemoved",
"portalModifiedBackgroundColor",
"portalModifiedBrandURL",
"portalModifiedBrandingLogoImage",
"portalModifiedCollectionAssetNavigator",
"portalModifiedCollectionsAdded",
"portalModifiedCollectionsRemoved",
"portalModifiedCookieLinkPrivacyPage",
"portalModifiedCookiePlacement",
"portalModifiedCustomMetadataIDsAdded",
"portalModifiedCustomMetadataIDsRemoved",
"portalModifiedDefaultMetadataFieldsAdded",
"portalModifiedDefaultMetadataFieldsRemoved",
"portalModifiedDownloadFormatsAdded",
"portalModifiedDownloadFormatsRemoved",
"portalModifiedEmailReceiver",
"portalModifiedFilterOptionsAdded",
"portalModifiedFilterOptionsRemoved",
"portalModifiedForceDownloadProof",
"portalModifiedForceWatermark",
"portalModifiedGeneralPassword",
"portalModifiedHasUserRegistration",
"portalModifiedHasWhitelabel",
"portalModifiedHeroArrowColor",
"portalModifiedHeroBannerImage",
"portalModifiedHeroFontColor",
"portalModifiedHeroLogoColor",
"portalModifiedHeroLogoImage",
"portalModifiedHostNames",
"portalModifiedIsActive",
"portalModifiedLandingPageOptions",
"portalModifiedLanguagesAdded",
"portalModifiedLanguagesRemoved",
"portalModifiedLicenseReleaseIDsAdded",
"portalModifiedLicenseReleaseIDsRemoved",
"portalModifiedMainHostName",
"portalModifiedMediaViewsAdded",
"portalModifiedMediaViewsRemoved",
"portalModifiedModelReleaseIDsAdded",
"portalModifiedModelReleaseIDsRemoved",
"portalModifiedName",
"portalModifiedOriginalDownloadFormatTypesAdded",
"portalModifiedOriginalDownloadFormatTypesRemoved",
"portalModifiedPageName",
"portalModifiedPagePlacementsAdded",
"portalModifiedPagePlacementsRemoved",
"portalModifiedPageText",
"portalModifiedPageTranslationCreated",
"portalModifiedPageTranslationLanguage",
"portalModifiedPageTranslationName",
"portalModifiedPageTranslationText",
"portalModifiedPagesAdded",
"portalModifiedPagesRemoved",
"portalModifiedPreferredMode",
"portalModifiedPreferredTitle",
"portalModifiedPropertyReleaseIDsAdded",
"portalModifiedPropertyReleaseIDsRemoved",
"portalModifiedProtectedCollectionsAdded",
"portalModifiedProtectedCollectionsRemoved",
"portalModifiedRestrictAccess",
"portalModifiedSearchFieldsAdded",
"portalModifiedSearchFieldsRemoved",
"portalModifiedShowAllLicenseReleases",
"portalModifiedShowAllModelReleases",
"portalModifiedShowAllPropertyReleases",
"portalModifiedShowBorder",
"portalModifiedShowCookieInformation",
"portalModifiedShowCreateLinkToFileTab",
"portalModifiedShowFileType",
"portalModifiedShowLicenseReleaseFile",
"portalModifiedShowModelReleaseFile",
"portalModifiedShowPropertyReleaseFile",
"portalModifiedShowStartScreen",
"portalModifiedSortOptionsAdded",
"portalModifiedSortOptionsRemoved",
"portalModifiedStandardMetadataIDsAdded",
"portalModifiedStandardMetadataIDsRemoved",
"portalModifiedStartScreenText",
"portalModifiedTranslationCookieTextShort",
"portalModifiedTranslationFooterText",
"portalModifiedTranslationHeroSlogan",
"portalModifiedTranslationLanguage",
"portalModifiedUseSSO",
"portalModifiedUseSemanticSearch",
"portalModifiedUserCompany",
"portalModifiedUserDepartment",
"portalModifiedUserEmail",
"portalModifiedUserFirstName",
"portalModifiedUserIsActive",
"portalModifiedUserIsConfirmed",
"portalModifiedUserLanguage",
"portalModifiedUserLastName",
"portalModifiedUserPassword",
"portalModifiedUsersAdded",
"portalModifiedUsersRemoved",
"propertyCreated",
"propertyDeleted",
"propertyFileCreated",
"propertyFileDeleted",
"propertyFileModifiedColor",
"propertyFileModifiedCreateDate",
"propertyFileModifiedFile",
"propertyFileModifiedName",
"propertyFileModifiedShowFile",
"propertyFileModifiedShowWarningMessage",
"propertyFileModifiedWarningMessage",
"propertyModifiedAddress",
"propertyModifiedName",
"propertyModifiedOwner",
"propertyReleaseTranslationCreated",
"propertyReleaseTranslationModifiedLanguage",
"propertyReleaseTranslationModifiedName",
"reportCreated",
"reportDeleted",
"reportModifiedAdditionalText",
"reportModifiedDayInMonth",
"reportModifiedDayInWeek",
"reportModifiedDayTime",
"reportModifiedIsActive",
"reportModifiedName",
"reportModifiedReceiverEmailsAdded",
"reportModifiedReceiverEmailsRemoved",
"reportModifiedReportEventsAdded",
"reportModifiedReportEventsRemoved",
"reportModifiedReportEventsReplaced",
"reportModifiedReportInterval",
"reportModifiedReportWhenNoData",
"reportModifiedSendCSV",
"reportModifiedSendPDF",
"reportUpdated",
"settingsModifiedCustomJavaScript",
"settingsModifiedDateFormat",
"settingsModifiedExternalCollectionSyncHostName",
"settingsModifiedExternalCollectionSyncPassword",
"settingsModifiedExternalCollectionSyncUserName",
"settingsModifiedExternalCustomCss",
"settingsModifiedExternalShareHostName",
"settingsModifiedExternalSharePassword",
"settingsModifiedExternalShareUserName",
"settingsModifiedFaviconFile",
"settingsModifiedFaviconText",
"settingsModifiedFont",
"settingsModifiedLogoBigDark",
"settingsModifiedLogoBigLight",
"settingsModifiedLogoBootFile",
"settingsModifiedLogoDarkFile",
"settingsModifiedLogoFile",
"settingsModifiedLogoIconDark",
"settingsModifiedLogoIconLight",
"settingsModifiedLogoLink",
"settingsModifiedPrimaryColorDark",
"settingsModifiedPrimaryColorLight",
"settingsModifiedProxyHostName",
"settingsModifiedProxyPort",
"settingsModifiedSMTPHasSSL",
"settingsModifiedSMTPHostName",
"settingsModifiedSMTPPassword",
"settingsModifiedSMTPPort",
"settingsModifiedSMTPTransmitterEmail",
"settingsModifiedSMTPTransmitterName",
"settingsModifiedSMTPUseDefault",
"settingsModifiedSMTPUserName",
"settingsModifiedSecondaryColorDark",
"settingsModifiedSecondaryColorLight",
"settingsModifiedSloganStartscreen",
"settingsModifiedStartscreenFile",
"settingsModifiedUploadLinkBackgroundFile",
"settingsModifiedWatermarkFile",
"settingsModifiedWatermarkPositionIsBottomLeft",
"settingsModifiedWatermarkPositionIsBottomMiddle",
"settingsModifiedWatermarkPositionIsBottomRight",
"settingsModifiedWatermarkPositionIsCenter",
"settingsModifiedWatermarkPositionIsMiddleLeft",
"settingsModifiedWatermarkPositionIsMiddleRight",
"settingsModifiedWatermarkPositionIsUpperLeft",
"settingsModifiedWatermarkPositionIsUpperMiddle",
"settingsModifiedWatermarkPositionIsUpperRight",
"settingsModifiedWatermarkPositioningType",
"settingsModifiedWatermarkText",
"settingsModifiedWatermarkTransparency",
"settingsModifiedWatermarkWidthPercent",
"spaceCreated",
"spaceDeleted",
"spaceModifiedAutomaticallyActivatedDomainsAdded",
"spaceModifiedAutomaticallyActivatedDomainsRemoved",
"spaceModifiedCopyrightText",
"spaceModifiedCustomBodyFontFileID",
"spaceModifiedCustomHeadingsFontFileID",
"spaceModifiedCustomMetadataIDs",
"spaceModifiedCustomization",
"spaceModifiedDefaultMetadataFields",
"spaceModifiedDownloadFormatIDsAdded",
"spaceModifiedDownloadFormatIDsRemoved",
"spaceModifiedFaviconImage",
"spaceModifiedForceDownloadProof",
"spaceModifiedForceWatermark",
"spaceModifiedHostNames",
"spaceModifiedIsActive",
"spaceModifiedLanguagesAdded",
"spaceModifiedLanguagesRemoved",
"spaceModifiedLicenseReleaseIDs",
"spaceModifiedLoginBackgroundImage",
"spaceModifiedLoginHeadline",
"spaceModifiedLoginRequired",
"spaceModifiedLogoDarkImage",
"spaceModifiedLogoLightImage",
"spaceModifiedMainHostName",
"spaceModifiedModelReleaseIDs",
"spaceModifiedName",
"spaceModifiedNavigationFooter",
"spaceModifiedNavigationHeader",
"spaceModifiedOriginalDownloadFormatTypesAdded",
"spaceModifiedOriginalDownloadFormatTypesRemoved",
"spaceModifiedPermissionGroupIDsAdded",
"spaceModifiedPermissionGroupIDsRemoved",
"spaceModifiedPermissionGroupsAdded",
"spaceModifiedPermissionGroupsRemoved",
"spaceModifiedPreferredTitle",
"spaceModifiedPrimaryColor",
"spaceModifiedPropertyReleaseIDs",
"spaceModifiedSearchFieldsAdded",
"spaceModifiedSearchFieldsRemoved",
"spaceModifiedSecondaryColor",
"spaceModifiedShowAllLicenseReleases",
"spaceModifiedShowAllModelReleases",
"spaceModifiedShowAllPropertyReleases",
"spaceModifiedShowFileType",
"spaceModifiedShowLicenseReleaseFile",
"spaceModifiedShowModelReleaseFile",
"spaceModifiedShowPropertyReleaseFile",
"spaceModifiedShowTermsOfUse",
"spaceModifiedStandardMetadataIDs",
"spaceModifiedStartScreenPage",
"spaceModifiedTermsOfUse",
"spaceModifiedUseSSO",
"spaceModifiedUseSemanticSearch",
"spaceNavigationFooterCreated",
"spaceNavigationFooterDeleted",
"spaceNavigationFooterLinkCreated",
"spaceNavigationFooterLinkDeleted",
"spaceNavigationFooterLinkTranslationCreated",
"spaceNavigationFooterTranslationCreated",
"spaceNavigationHeaderCategoryCreated",
"spaceNavigationHeaderCategoryDeleted",
"spaceNavigationHeaderCategoryTranslationCreated",
"spaceNavigationHeaderCreated",
"spaceNavigationHeaderDeleted",
"spaceNavigationHeaderTranslationCreated",
"spaceNavigationModifiedAnchor",
"spaceNavigationModifiedFooterFooterText",
"spaceNavigationModifiedFooterLinkName",
"spaceNavigationModifiedFooterLinkOrder",
"spaceNavigationModifiedFooterName",
"spaceNavigationModifiedFooterOrder",
"spaceNavigationModifiedHeaderCategoryName",
"spaceNavigationModifiedHeaderCategoryOrder",
"spaceNavigationModifiedHeaderName",
"spaceNavigationModifiedHeaderOrder",
"spaceNavigationModifiedLink",
"spaceNavigationModifiedSpacePageID",
"spacePageCreated",
"spacePageDeleted",
"spacePageModifiedContent",
"spacePageModifiedName",
"spacePageModifiedSlug",
"spacePageTemplateCreated",
"spacePageTemplateDeleted",
"spacePageTemplateUpdated",
"spacePageTranslationCreated",
"spaceTemplateCreated",
"spaceTemplateDeleted",
"spaceTemplateUpdated",
"standardMetadataCreated",
"standardMetadataDeleted",
"standardMetadataModifiedValue",
"standardMetadataModifiedValueType",
"synonymColumnsModifiedSynonym1",
"synonymColumnsModifiedSynonym10",
"synonymColumnsModifiedSynonym11",
"synonymColumnsModifiedSynonym12",
"synonymColumnsModifiedSynonym13",
"synonymColumnsModifiedSynonym14",
"synonymColumnsModifiedSynonym15",
"synonymColumnsModifiedSynonym16",
"synonymColumnsModifiedSynonym17",
"synonymColumnsModifiedSynonym18",
"synonymColumnsModifiedSynonym19",
"synonymColumnsModifiedSynonym2",
"synonymColumnsModifiedSynonym20",
"synonymColumnsModifiedSynonym3",
"synonymColumnsModifiedSynonym4",
"synonymColumnsModifiedSynonym5",
"synonymColumnsModifiedSynonym6",
"synonymColumnsModifiedSynonym7",
"synonymColumnsModifiedSynonym8",
"synonymColumnsModifiedSynonym9",
"synonymCreated",
"synonymDeleted",
"synonymModifiedSynonym",
"tenantModifiedAdditionalDiskSpaceGigaByte",
"tenantModifiedCustomUnlockedFeatures",
"tenantModifiedCustomUnlockedFeaturesAdded",
"tenantModifiedCustomUnlockedFeaturesRemoved",
"tenantModifiedExpirationDate",
"tenantModifiedMediaPortalLimit",
"tenantModifiedPackageIdentifier",
"tenantModifiedReadOnlyUserLimit",
"tenantModifiedUserLimit",
"trashCreated",
"trashDeleted",
"trashFileIDsRestored",
"uploadLinkCreated",
"uploadLinkDeleted",
"uploadLinkFileUploaded",
"uploadLinkModifiedDescription",
"uploadLinkModifiedDirectoryID",
"uploadLinkModifiedEmailsAdded",
"uploadLinkModifiedFaceRecognitionDisabled",
"uploadLinkModifiedFileStateID",
"uploadLinkModifiedFilesAdded",
"uploadLinkModifiedFilesRemoved",
"uploadLinkModifiedIsDisabled",
"uploadLinkModifiedKeywordsAdded",
"uploadLinkModifiedKeywordsRemoved",
"uploadLinkModifiedLicenseReleaseIDsAdded",
"uploadLinkModifiedLicenseReleaseIDsRemoved",
"uploadLinkModifiedModelReleaseIDsAdded",
"uploadLinkModifiedModelReleaseIDsRemoved",
"uploadLinkModifiedName",
"uploadLinkModifiedNotificationText",
"uploadLinkModifiedPropertyReleaseIDsAdded",
"uploadLinkModifiedPropertyReleaseIDsRemoved",
"uploadLinkModifiedShowAllLicenseReleases",
"uploadLinkModifiedShowAllModelReleases",
"uploadLinkModifiedShowAllPropertyReleases",
"uploadLinkModifiedUploadCondition",
"uploadLinkModifiedUserID",
"uploadLinkModifiedValidityPeriod",
"userCreated",
"userDeleted",
"userModifiedCIFSPassword",
"userModifiedEmail",
"userModifiedFirstName",
"userModifiedIsActive",
"userModifiedIsExternal",
"userModifiedLanguage",
"userModifiedLastName",
"userModifiedLinked",
"userModifiedPassword",
"userModifiedPermissionGroupIDsAdded",
"userModifiedPermissionGroupIDsRemoved",
"userModifiedRefreshToken",
"userModifiedResetPasswordStamp",
"userModifiedResetPasswordToken",
"userModifiedSecret",
"userModifiedSecretExpirationDate",
"userModifiedTwoFactorAuthSetUp",
"userModifiedUnlinked",
"userModifiedUserName",
"userTrackingCreated",
"userTrackingDeleted",
"userTrackingModifiedFirstMonthlyLogin",
"userTrackingModifiedUserID",
"variantStackCreated",
"variantStackDeleted",
"variantStackModifiedDescription",
"variantStackModifiedFilesAdded",
"variantStackModifiedFilesRemoved",
"variantStackModifiedName",
"webhookCreated",
"webhookDeleted",
"webhookModifiedDescription",
"webhookModifiedEventKey",
"webhookModifiedEventKeysAdded",
"webhookModifiedEventKeysRemoved",
"webhookModifiedName",
"webhookModifiedSecret",
"webhookModifiedURL"
],
"example": "fileCreated",
"title": "EventKey",
"type": "string"
},
"type": "array"
},
"ArraySchema_3639323535": {
"description": "The removed searchFields.",
"items": {
"enum": [
"Creator",
"Description",
"DynamicMetadata",
"FileName",
"Keywords",
"KeywordsAuto",
"Subject",
"Synonyms",
"gpsInfo"
],
"example": "gpsInfo",
"title": "PortalSearchField",
"type": "string"
},
"type": "array"
},
"ArraySchema_3639636131": {
"description": "The IDs of the standard metadata that were added.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3661663934": {
"description": "The added licenseFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_3730383333": {
"description": "The deleted licenseFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_3732626131": {
"description": "The added ipRange.",
"items": {
"description": "A network address",
"example": "192.0.2.0/24",
"title": "IPNetAddress",
"type": "string"
},
"type": "array"
},
"ArraySchema_3732663935": {
"description": "The  parentConditionCustomMetadataOptionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3733303735": {
"description": "The removed fileStatesToAssign.",
"items": {
"$ref": "#/components/schemas/FileStateInfo"
},
"type": "array"
},
"ArraySchema_3733313866": {
"description": "The added pages.",
"items": {
"$ref": "#/components/schemas/PortalPageInfo"
},
"type": "array"
},
"ArraySchema_3734303064": {
"description": "The added defaultLanguageCodes.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3739343737": {
"description": "The added languages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3765353461": {
"description": "The added receiverEmails.",
"items": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"type": "array"
},
"ArraySchema_3765383666": {
"description": "The added languageCodes.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_3766376639": {
"description": "The removed files.",
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
"ArraySchema_3830326239": {
"description": "The removed directoryIDsToUpload.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3832323563": {
"description": "The removed reportEvents.",
"items": {
"$ref": "#/components/schemas/ReportEvent"
},
"type": "array"
},
"ArraySchema_3833383238": {
"description": "The added directoryIDsToCreate.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3833663633": {
"description": "The deleted keywords.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_3834366665": {
"description": "The properties.",
"items": {
"$ref": "#/components/schemas/Property_3530383236"
},
"type": "array"
},
"ArraySchema_3837363038": {
"description": "The added filterOptions.",
"items": {
"enum": [
"languageCode"
],
"example": "languageCode",
"title": "PortalFilterType",
"type": "string"
},
"type": "array"
},
"ArraySchema_3838323231": {
"description": "The removed defaultMetadataFields.",
"items": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"type": "array"
},
"ArraySchema_3864613737": {
"description": "The operations to perform on the index tenant.",
"items": {
"description": "IndexOperation is an entity that represents the type of indexing operation to be performed.",
"enum": [
"face_recognition",
"semantic_search",
"smart_tagging",
"text_recognition"
],
"example": "smart_tagging",
"title": "IndexOperation",
"type": "string"
},
"type": "array"
},
"ArraySchema_3930336232": {
"description": "The removed downloadFormatIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3930653232": {
"description": "The removed infos.",
"items": {
"$ref": "#/components/schemas/LicenseData"
},
"type": "array"
},
"ArraySchema_3932353034": {
"description": "The deleted modelFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_3933643866": {
"description": "The fileSize of the downloaded files.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_3933666636": {
"description": "The groups which have been activated.",
"items": {
"$ref": "#/components/schemas/AzureActiveDirectoryGroup"
},
"type": "array"
},
"ArraySchema_3934656561": {
"description": "The removed receiverEmails.",
"items": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"type": "array"
},
"ArraySchema_3935383130": {
"description": "The removed placements.",
"items": {
"description": "A placement of a portal page",
"enum": [
"cookie",
"download",
"footer",
"login",
"termsAndServices"
],
"example": "footer",
"title": "PortalPagePlacement",
"type": "string"
},
"type": "array"
},
"ArraySchema_3936316338": {
"description": "The permissionGroups.",
"items": {
"$ref": "#/components/schemas/PermissionGroup"
},
"type": "array"
},
"ArraySchema_3939316139": {
"description": "The added propertyReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_3961363463": {
"description": "The removed directoryIDsToEdit.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_3965393533": {
"description": "The replaced reportEvents.",
"items": {
"$ref": "#/components/schemas/ReportEvent"
},
"type": "array"
},
"ArraySchema_6136313961": {
"description": "The added reportEvents.",
"items": {
"$ref": "#/components/schemas/ReportEvent"
},
"type": "array"
},
"ArraySchema_6136393661": {
"description": "The old parentConditionCustomMetadataOptionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6162343139": {
"description": "The deleted propertyFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_6162366235": {
"description": "The added placements.",
"items": {
"description": "A placement of a portal page",
"enum": [
"cookie",
"download",
"footer",
"login",
"termsAndServices"
],
"example": "footer",
"title": "PortalPagePlacement",
"type": "string"
},
"type": "array"
},
"ArraySchema_6163373163": {
"description": "The added searchFields.",
"items": {
"enum": [
"Creator",
"Description",
"DynamicMetadata",
"FileName",
"Keywords",
"KeywordsAuto",
"Subject",
"Synonyms",
"gpsInfo"
],
"example": "gpsInfo",
"title": "PortalSearchField",
"type": "string"
},
"type": "array"
},
"ArraySchema_6164633031": {
"description": "The spacePageTemplates that were unassigned from this spaceTemplate.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6230313933": {
"description": "The added fileDetails.",
"items": {
"description": "The type of the FileDetail",
"enum": [
"basicMetadata",
"importantMetadata",
"licenseInfo",
"unimportantMetadata"
],
"example": "unimportantMetadata",
"title": "FileDetail",
"type": "string"
},
"type": "array"
},
"ArraySchema_6233343262": {
"description": "The added keywords.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_6233373335": {
"description": "\u003cbr\u003eDoes not exist when `showParents = false`",
"items": {
"$ref": "#/components/schemas/Directory"
},
"type": "array"
},
"ArraySchema_6236383334": {
"description": "The removed collectionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6237356466": {
"description": "The added fileStatesToAssign.",
"items": {
"$ref": "#/components/schemas/FileStateInfo"
},
"type": "array"
},
"ArraySchema_6239396635": {
"description": "The added customerGroups.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_6264336132": {
"description": "The permissionGroups with which the collection is unshared.",
"items": {
"$ref": "#/components/schemas/PermissionGroupInfo"
},
"type": "array"
},
"ArraySchema_6266633261": {
"description": "The removed unlockedCustomerGroups.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_6330373033": {
"description": "The files which have been commented.",
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
"ArraySchema_6331323166": {
"description": "The removed ipRange.",
"items": {
"description": "A network address",
"example": "192.0.2.0/24",
"title": "IPNetAddress",
"type": "string"
},
"type": "array"
},
"ArraySchema_6331643262": {
"description": "The removed fileDetails.",
"items": {
"description": "The type of the FileDetail",
"enum": [
"basicMetadata",
"importantMetadata",
"licenseInfo",
"unimportantMetadata"
],
"example": "unimportantMetadata",
"title": "FileDetail",
"type": "string"
},
"type": "array"
},
"ArraySchema_6335373834": {
"description": "The added automaticallyActivatedDomains.",
"items": {
"description": "A domain of an url",
"example": "www.google.com",
"title": "Domain",
"type": "string"
},
"type": "array"
},
"ArraySchema_6335623334": {
"description": "\u003cbr\u003e**Not exist when:** showFiles: false",
"items": {
"$ref": "#/components/schemas/File"
},
"type": "array"
},
"ArraySchema_6336313931": {
"description": "The removed sortOptions.",
"items": {
"description": "A sort type.",
"enum": [
"createDate",
"fileName",
"subject",
"uploadDate"
],
"example": "uploadDate",
"title": "SortType",
"type": "string"
},
"type": "array"
},
"ArraySchema_6337626261": {
"description": "The fileIDs that were restored.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6338623563": {
"description": "The added metadataFieldMultiSelections.",
"items": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3732363832"
},
"type": "array"
},
"ArraySchema_6339343636": {
"description": "The added originalDownloadFormatTypes.",
"items": {
"description": "FormatType is an Entity for a FormatType. A FormatType describes a set of FileBasic Extensions, the Web FormatType for example consists of the FileBasic Extensions JPG, JPEG, GIF and PNG.",
"enum": [
"archive",
"audio",
"converted",
"image",
"imageconverted",
"office",
"other",
"pdf",
"raw",
"raw-image",
"vector",
"video",
"web",
"web-image",
"webimage"
],
"example": "web",
"title": "FormatType",
"type": "string"
},
"type": "array"
},
"ArraySchema_6430343739": {
"description": "The added modelReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6430633836": {
"description": "The removed filterOptions.",
"items": {
"enum": [
"languageCode"
],
"example": "languageCode",
"title": "PortalFilterType",
"type": "string"
},
"type": "array"
},
"ArraySchema_6431616537": {
"description": "The added files.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6432616539": {
"description": "The added permissionGroupIDs.",
"items": {
"$ref": "#/components/schemas/PermissionGroupInfo"
},
"type": "array"
},
"ArraySchema_6434353666": {
"description": "The IDs of the custom metadata that were added.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6435313162": {
"description": "The removed uploadObligations.",
"items": {
"$ref": "#/components/schemas/UploadObligation"
},
"type": "array"
},
"ArraySchema_6436316532": {
"description": "The removed mediaViewsRemoved.",
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"type": "array"
},
"ArraySchema_6462666233": {
"description": "The files which have been added.",
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
"ArraySchema_6463623432": {
"description": "The added collectionIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6465306239": {
"description": "The removed translationLanguages.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_6465653837": {
"description": "The removed markedUserIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6530316332": {
"description": "The added propertyFiles.",
"items": {
"$ref": "#/components/schemas/LicenseFileInfo"
},
"type": "array"
},
"ArraySchema_6534616231": {
"description": "The permissionGroups with which the collection is shared.",
"items": {
"$ref": "#/components/schemas/PermissionGroupInfo"
},
"type": "array"
},
"ArraySchema_6539356565": {
"description": "The new metadataFieldsOrder.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6563376663": {
"description": "The removed fileStatesToShow.",
"items": {
"$ref": "#/components/schemas/FileStateInfo"
},
"type": "array"
},
"ArraySchema_6564633838": {
"description": "The added defaultMetadataFields.",
"items": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"type": "array"
},
"ArraySchema_6565326330": {
"description": "The added availablePlugins.",
"items": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"type": "array"
},
"ArraySchema_6565363231": {
"description": "The added markedUserIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6630303262": {
"description": "The removed permissionGroups.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6633646263": {
"description": "The receivers with which the collection is external shared with.",
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"type": "array"
},
"ArraySchema_6634353630": {
"description": "The removed languageCodes.",
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"ArraySchema_6634396663": {
"description": "The customMetadata.",
"items": {
"$ref": "#/components/schemas/CustomMetadata"
},
"type": "array"
},
"ArraySchema_6638656432": {
"description": "The removed modelReleaseIDs.",
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"ArraySchema_6639323131": {
"description": "The added directoryIDsToEdit.",
"items": {
"$ref": "#/components/schemas/DirectoryInfo"
},
"type": "array"
},
"ArraySchema_6639353132": {
"description": "The removed customerGroups.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_6661303537": {
"description": "The ids of the modified files.",
"items": {
"example": [
12,
34,
46
],
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"ArraySchema_6662633533": {
"description": "The added selectionTerms.",
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"ArraySchema_6662666538": {
"description": "The added emails.",
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"type": "array"
},
"ArraySchema_6663346135": {
"description": "The added users.",
"items": {
"$ref": "#/components/schemas/UserInfo_6263373834"
},
"type": "array"
},
"ArraySchema_6664303565": {
"description": "\u003cbr\u003eDoes not exist when `showChildren = false`",
"items": {
"$ref": "#/components/schemas/Directory"
},
"type": "array"
},
"ArraySchema_6666336535": {
"description": "The users with which the collection is shared.",
"items": {
"$ref": "#/components/schemas/UserInfo_6263373834"
},
"type": "array"
},
"AssetNavigatorBasic": {
"properties": {
"assetNavigatorCategories": {
"items": {
"$ref": "#/components/schemas/AssetNavigatorCategoryBasic"
},
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "AssetNavigatorBasic",
"type": "object"
},
"AssetNavigatorCategoryBasic": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"metadataField": {
"$ref": "#/components/schemas/Metadata"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
}
},
"title": "AssetNavigatorCategoryBasic",
"type": "object"
},
"AssetNavigatorCategoryModifiedMetadataFieldID": {
"properties": {
"newMetadataFieldID": {
"description": "The new metadatafieldid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldMetadataFieldID": {
"description": "The old metadatafieldid.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "AssetNavigatorCategoryModifiedMetadataFieldID",
"type": "object"
},
"AssetNavigatorCategoryModifiedOrder": {
"properties": {
"newOrder": {
"description": "The new order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "The old order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "AssetNavigatorCategoryModifiedOrder",
"type": "object"
},
"AssetNavigatorCategoryTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "AssetNavigatorCategoryTranslationModifiedLanguage",
"type": "object"
},
"AssetNavigatorCategoryTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "AssetNavigatorCategoryTranslationModifiedName",
"type": "object"
},
"AssetNavigatorModifiedCategory": {
"properties": {
"assetNavigatorCategoryID": {
"description": "The new assetNavigatorCategoryID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "AssetNavigatorModifiedCategory",
"type": "object"
},
"AssetNavigatorModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "AssetNavigatorModifiedDescription",
"type": "object"
},
"AssetNavigatorModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "AssetNavigatorModifiedName",
"type": "object"
},
"AzureActiveDirectoryGroup": {
"description": "A group in the Azure Active DirectoryBasic",
"example": {
"isActive": true,
"membersCount": 5,
"name": "Group 1",
"uniqueID": "12345678-1234-1234-1234-123456789012"
},
"properties": {
"isActive": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"membersCount": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"uniqueID": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "AzureActiveDirectoryGroup",
"type": "object"
},
"AzureActiveDirectoryModifiedClientID": {
"properties": {
"newClientID": {
"description": "The new clientID.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldClientID": {
"description": "The old clientID.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "AzureActiveDirectoryModifiedClientID",
"type": "object"
},
"AzureActiveDirectoryModifiedDeleteMode": {
"properties": {
"newDeleteMode": {
"description": "The new deleteMode.",
"enum": [
"delete",
"deletewhenempty",
"unlink"
],
"example": "delete",
"title": "DeleteMode",
"type": "string"
},
"oldDeleteMode": {
"description": "The old deleteMode.",
"enum": [
"delete",
"deletewhenempty",
"unlink"
],
"example": "delete",
"title": "DeleteMode",
"type": "string"
}
},
"title": "AzureActiveDirectoryModifiedDeleteMode",
"type": "object"
},
"AzureActiveDirectoryModifiedGroupsActivated": {
"properties": {
"groupsActivated": {
"$ref": "#/components/schemas/ArraySchema_3933666636"
}
},
"title": "AzureActiveDirectoryModifiedGroupsActivated",
"type": "object"
},
"AzureActiveDirectoryModifiedGroupsAdded": {
"properties": {
"groupsAdded": {
"$ref": "#/components/schemas/ArraySchema_3262343932"
}
},
"title": "AzureActiveDirectoryModifiedGroupsAdded",
"type": "object"
},
"AzureActiveDirectoryModifiedGroupsDeactivated": {
"properties": {
"groupsDeactivated": {
"$ref": "#/components/schemas/ArraySchema_3133613333"
}
},
"title": "AzureActiveDirectoryModifiedGroupsDeactivated",
"type": "object"
},
"AzureActiveDirectoryModifiedGroupsRemoved": {
"properties": {
"groupsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3262306338"
}
},
"title": "AzureActiveDirectoryModifiedGroupsRemoved",
"type": "object"
},
"AzureActiveDirectoryModifiedIPRangeAdded": {
"properties": {
"ipRangeAdded": {
"$ref": "#/components/schemas/ArraySchema_3732626131"
}
},
"title": "AzureActiveDirectoryModifiedIPRangeAdded",
"type": "object"
},
"AzureActiveDirectoryModifiedIPRangeRemoved": {
"properties": {
"ipRangeRemoved": {
"$ref": "#/components/schemas/ArraySchema_6331323166"
}
},
"title": "AzureActiveDirectoryModifiedIPRangeRemoved",
"type": "object"
},
"AzureActiveDirectoryModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "AzureActiveDirectoryModifiedName",
"type": "object"
},
"AzureActiveDirectoryModifiedNewUserDataOwner": {
"properties": {
"newNewUserDataOwner": {
"description": "The new newUserDataOwner.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldNewUserDataOwner": {
"description": "The old newUserDataOwner.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "AzureActiveDirectoryModifiedNewUserDataOwner",
"type": "object"
},
"AzureActiveDirectoryModifiedRecursive": {
"properties": {
"newRecursive": {
"type": "boolean"
},
"oldRecursive": {
"type": "boolean"
}
},
"title": "AzureActiveDirectoryModifiedRecursive",
"type": "object"
},
"AzureActiveDirectoryModifiedSyncTime": {
"properties": {
"newSyncTime": {
"description": "The new syncTime.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldSyncTime": {
"description": "The old syncTime.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "AzureActiveDirectoryModifiedSyncTime",
"type": "object"
},
"AzureActiveDirectoryModifiedTenantID": {
"properties": {
"newTenantID": {
"description": "The new tenantID.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldTenantID": {
"description": "The old tenantID.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "AzureActiveDirectoryModifiedTenantID",
"type": "object"
},
"BoundingBox": {
"description": "The face bounding box in an image or video.",
"example": {
"height": 100.46,
"left": 50.5,
"top": 50.5,
"width": 100.5
},
"properties": {
"height": {
"type": "number"
},
"left": {
"type": "number"
},
"top": {
"type": "number"
},
"width": {
"type": "number"
}
},
"title": "BoundingBox",
"type": "object"
},
"Collection": {
"properties": {
"assetNavigator": {
"$ref": "#/components/schemas/AssetNavigatorBasic"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"filesQuantity": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"filesQuantityWithFilter": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"isDynamic": {
"type": "boolean"
},
"isSharedExternally": {
"type": "boolean"
},
"isSharedGlobally": {
"type": "boolean"
},
"isSharedInternally": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForCollection"
},
"previewFiles": {
"items": {
"$ref": "#/components/schemas/FileBasic"
},
"type": "array"
},
"sharedPermissionGroups": {
"items": {
"$ref": "#/components/schemas/PermissionGroupBasic"
},
"type": "array"
},
"sharedUsers": {
"items": {
"$ref": "#/components/schemas/UserBasic"
},
"type": "array"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"userHasPermissionForCollection": {
"type": "boolean"
}
},
"title": "Collection",
"type": "object"
},
"CollectionBasic": {
"properties": {
"assetNavigator": {
"$ref": "#/components/schemas/AssetNavigatorBasic"
},
"description": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"isDynamic": {
"type": "boolean"
},
"isSharedExternally": {
"type": "boolean"
},
"isSharedGlobally": {
"type": "boolean"
},
"isSharedInternally": {
"type": "boolean"
},
"name": {
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForCollection"
},
"previewFiles": {
"items": {
"$ref": "#/components/schemas/FileBasic"
},
"type": "array"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"userHasPermissionForCollection": {
"type": "boolean"
}
},
"title": "CollectionBasic",
"type": "object"
},
"CollectionDeleteObject": {
"example": {
"error": "",
"id": 5
},
"properties": {
"error": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CollectionDeleteObject",
"type": "object"
},
"CollectionInfo": {
"example": {
"id": 5,
"name": "My Collection"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CollectionInfo",
"type": "object"
},
"CollectionModifiedAssetNavigatorID": {
"properties": {
"newAssetNavigatorID": {
"description": "The new assetNavigatorID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldAssetNavigatorID": {
"description": "The old assetNavigatorID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CollectionModifiedAssetNavigatorID",
"type": "object"
},
"CollectionModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "CollectionModifiedDescription",
"type": "object"
},
"CollectionModifiedFilesAdded": {
"properties": {
"filesAdded": {
"$ref": "#/components/schemas/ArraySchema_6462666233"
}
},
"title": "CollectionModifiedFilesAdded",
"type": "object"
},
"CollectionModifiedFilesCommented": {
"properties": {
"collectionID": {
"description": "The collection ID of the files.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"comment": {
"description": "The comment.",
"type": "string"
},
"commentID": {
"description": "The comment ID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filesCommented": {
"$ref": "#/components/schemas/ArraySchema_6330373033"
}
},
"title": "CollectionModifiedFilesCommented",
"type": "object"
},
"CollectionModifiedFilesRemoved": {
"properties": {
"filesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3634383538"
}
},
"title": "CollectionModifiedFilesRemoved",
"type": "object"
},
"CollectionModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "CollectionModifiedLanguage",
"type": "object"
},
"CollectionModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CollectionModifiedName",
"type": "object"
},
"CollectionModifiedPreviewFileIDs": {
"properties": {
"newPreviewFileIDs": {
"$ref": "#/components/schemas/ArraySchema_3230363237"
},
"oldPreviewFileIDs": {
"$ref": "#/components/schemas/ArraySchema_3039306363"
}
},
"title": "CollectionModifiedPreviewFileIDs",
"type": "object"
},
"CollectionModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newUserName": {
"description": "The new userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserName": {
"description": "The old userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "CollectionModifiedUserID",
"type": "object"
},
"CollectionSharedExternally": {
"properties": {
"receivers": {
"$ref": "#/components/schemas/ArraySchema_6633646263"
}
},
"title": "CollectionSharedExternally",
"type": "object"
},
"CollectionSharedInternally": {
"properties": {
"isSharedGlobally": {
"description": "The flag indicates if the collection is shared globally.",
"type": "boolean"
},
"shareMessage": {
"description": "The shareMessage.",
"type": "string"
},
"sharedPermissionGroups": {
"$ref": "#/components/schemas/ArraySchema_6534616231"
},
"sharedUsers": {
"$ref": "#/components/schemas/ArraySchema_6666336535"
}
},
"title": "CollectionSharedInternally",
"type": "object"
},
"CollectionTranslationModifiedDescription": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "CollectionTranslationModifiedDescription",
"type": "object"
},
"CollectionTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CollectionTranslationModifiedName",
"type": "object"
},
"CollectionUnsharedInternally": {
"properties": {
"unsharedPermissionGroups": {
"$ref": "#/components/schemas/ArraySchema_6264336132"
},
"unsharedUsers": {
"$ref": "#/components/schemas/ArraySchema_3063633030"
}
},
"title": "CollectionUnsharedInternally",
"type": "object"
},
"CommentCreated": {
"properties": {
"content": {
"description": "The content of the comment.",
"type": "string"
},
"fileID": {
"description": "The file ID of the comment.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CommentCreated",
"type": "object"
},
"CommentDeleted": {
"properties": {
"content": {
"description": "The content of the comment.",
"type": "string"
},
"fileID": {
"description": "The file ID of the comment.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CommentDeleted",
"type": "object"
},
"CropSector": {
"description": "\u003cp\u003eCrops the file with the specified settings. Those parameters all refer to the original image (with its original size returned by GET FileBasic). The unit is measured in Pixel.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"Height": 345,
"OffsetX": 234,
"OffsetY": 123,
"Width": 456
},
"properties": {
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"offsetX": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"offsetY": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "CropSector",
"type": "object"
},
"CropSector_6463376534": {
"description": "The crop sector of the image for the conversion request.",
"example": {
"Height": 345,
"OffsetX": 234,
"OffsetY": 123,
"Width": 456
},
"properties": {
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"offsetX": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"offsetY": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "CropSector",
"type": "object"
},
"CustomMetadata": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"parentCondition": {
"$ref": "#/components/schemas/CustomMetadataParentCondition"
},
"selectionOptions": {
"items": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3732363832"
},
"type": "array"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
}
},
"title": "CustomMetadata",
"type": "object"
},
"CustomMetadataLanguagesModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CustomMetadataLanguagesModifiedName",
"type": "object"
},
"CustomMetadataOptionsDeleted": {
"properties": {
"customMetadataID": {
"description": "The ID of the custom metadata the selection option belonged to.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"selectionOptionID": {
"description": "The ID of the deleted selection option.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CustomMetadataOptionsDeleted",
"type": "object"
},
"CustomMetadataOptionsLanguageDeleted": {
"properties": {
"customMetadataID": {
"description": "The ID of the custom metadata the selection option belonged to.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"selectionOptionID": {
"description": "The ID of the deleted selection option.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CustomMetadataOptionsLanguageDeleted",
"type": "object"
},
"CustomMetadataOptionsLanguageModifiedName": {
"properties": {
"customMetadataID": {
"description": "The ID of the custom metadata the selection option belongs to.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"selectionOptionID": {
"description": "The ID of the modified selection option.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CustomMetadataOptionsLanguageModifiedName",
"type": "object"
},
"CustomMetadataOptionsModifiedOrder": {
"properties": {
"newOrder": {
"description": "The new order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "The old order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CustomMetadataOptionsModifiedOrder",
"type": "object"
},
"CustomMetadataParentCondition": {
"example": {
"customMetadataID": 1,
"customMetadataOptionIDs": [
2,
3,
4
]
},
"properties": {
"customMetadataID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"customMetadataOptionIDs": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "CustomMetadataParentCondition",
"type": "object"
},
"CustomMetadataParentConditionModifiedCustomMetadataID": {
"properties": {
"newParentConditionCustomMetadataID": {
"description": "The bew parentConditionCustomMetadataID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldParentConditionCustomMetadataID": {
"description": "The old parentConditionCustomMetadataID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "CustomMetadataParentConditionModifiedCustomMetadataID",
"type": "object"
},
"CustomMetadataParentConditionModifiedCustomMetadataOptionIDs": {
"properties": {
"newParentConditionCustomMetadataOptionIDs": {
"$ref": "#/components/schemas/ArraySchema_3732663935"
},
"oldParentConditionCustomMetadataOptionIDs": {
"$ref": "#/components/schemas/ArraySchema_6136393661"
}
},
"title": "CustomMetadataParentConditionModifiedCustomMetadataOptionIDs",
"type": "object"
},
"CustomMetadataSelectionOption": {
"description": "The new metadataFieldSelection.",
"example": {
"id": 1,
"name": "Option 1",
"order": "fji"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CustomMetadataSelectionOption",
"type": "object"
},
"CustomMetadataSelectionOption_3561656530": {
"description": "The old metadataFieldSelection.",
"example": {
"id": 1,
"name": "Option 1",
"order": "fji"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CustomMetadataSelectionOption",
"type": "object"
},
"CustomMetadataSelectionOption_3732363832": {
"example": {
"id": 1,
"name": "Option 1",
"order": "fji"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "CustomMetadataSelectionOption",
"type": "object"
},
"CustomMetadataTranslationStateObject": {
"description": "The translation state of the custom metadata.",
"example": {
"language": "en",
"translationState": "complete"
},
"properties": {
"language": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"translationState": {
"description": "The state of the translation.",
"enum": [
"complete",
"empty",
"incomplete"
],
"example": "complete",
"title": "TranslationState",
"type": "string"
}
},
"title": "CustomMetadataTranslationStateObject",
"type": "object"
},
"CustomMetadata_6665623532": {
"description": "The fileState.",
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"parentCondition": {
"$ref": "#/components/schemas/CustomMetadataParentCondition"
},
"selectionOptions": {
"items": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3732363832"
},
"type": "array"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
}
},
"title": "CustomMetadata",
"type": "object"
},
"DataModelReleaseTranslationsModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "DataModelReleaseTranslationsModifiedLanguage",
"type": "object"
},
"DataModelReleaseTranslationsModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DataModelReleaseTranslationsModifiedName",
"type": "object"
},
"DirectLink": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"downloadFormat": {
"$ref": "#/components/schemas/DownloadFormatBasic"
},
"file": {
"$ref": "#/components/schemas/FileBasic"
},
"fileExtension": {
"description": "FileExtension is an Entity for a FileExtension. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileExtension are replaced by one whitespace.",
"example": "JPG",
"title": "FileExtension",
"type": "string"
},
"fileName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isOriginal": {
"type": "boolean"
},
"isPreview": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "DirectLink",
"type": "object"
},
"DirectLinkModifiedDownloadFormatID": {
"properties": {
"removedDownloadFormatID": {
"description": "The removedDownloadFormatID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "DirectLinkModifiedDownloadFormatID",
"type": "object"
},
"DirectLinkModifiedFileID": {
"properties": {
"newFile": {
"$ref": "#/components/schemas/FileInfo_6434383135"
},
"oldFile": {
"$ref": "#/components/schemas/FileInfo_6535353066"
}
},
"title": "DirectLinkModifiedFileID",
"type": "object"
},
"DirectLinkModifiedFileName": {
"properties": {
"newFileName": {
"description": "The new fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"oldFileName": {
"description": "The old fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "DirectLinkModifiedFileName",
"type": "object"
},
"DirectLinkModifiedFileSize": {
"properties": {
"newFileSize": {
"description": "The new fileSize.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"oldFileSize": {
"description": "The old fileSize.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
}
},
"title": "DirectLinkModifiedFileSize",
"type": "object"
},
"Directory": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"idPath": {
"type": "string"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"parentID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"path": {
"description": "Path is an Entity for a Path. Control Characters at the beginning and end of the path are removed. Control Characters inside the path are replaced by one whitespace. The path may not contain the sequence \"//\", \" /\" or \"/ \".",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForDirectory"
},
"quantity": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"quantityWithSubdirectories": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"totalFileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"totalFileSizeWithSubdirectories": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
}
},
"title": "Directory",
"type": "object"
},
"DirectoryBasic": {
"properties": {
"hasChildren": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"idPath": {
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"path": {
"description": "Path is an Entity for a Path. Control Characters at the beginning and end of the path are removed. Control Characters inside the path are replaced by one whitespace. The path may not contain the sequence \"//\", \" /\" or \"/ \".",
"example": "/path/to/file",
"title": "Path",
"type": "string"
}
},
"title": "DirectoryBasic",
"type": "object"
},
"DirectoryInfo": {
"example": {
"id": 5,
"name": "myDirectory1"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DirectoryInfo",
"type": "object"
},
"DirectoryModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "My DirectoryBasic",
"title": "DirectoryName",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "My DirectoryBasic",
"title": "DirectoryName",
"type": "string"
}
},
"title": "DirectoryModifiedName",
"type": "object"
},
"DirectoryModifiedParentDirectoryID": {
"properties": {
"newDirectoryIDPath": {
"description": "The new directoryIDPath.",
"example": "/12/23/34/",
"title": "DirectoryIDPath",
"type": "string"
},
"newDirectoryPath": {
"description": "The new directoryPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"newParentDirectoryID": {
"description": "The old parentDirectoryID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldDirectoryIDPath": {
"description": "The old directoryIDPath.",
"example": "/12/23/34/",
"title": "DirectoryIDPath",
"type": "string"
},
"oldDirectoryPath": {
"description": "The old directoryPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"oldParentDirectoryID": {
"description": "The old parentDirectoryID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "DirectoryModifiedParentDirectoryID",
"type": "object"
},
"DirectoryPermissions": {
"properties": {
"allDirectories": {
"type": "boolean"
},
"directories": {
"items": {
"$ref": "#/components/schemas/DirectoryBasic"
},
"type": "array"
},
"homeDirectory": {
"type": "boolean"
},
"selectedAllDirectories": {
"type": "boolean"
}
},
"title": "DirectoryPermissions",
"type": "object"
},
"DownloadFormat": {
"properties": {
"colorspace": {
"description": "The colorspace of a media file.",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"density": {
"description": "The density of the picture.",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
},
"formatConversion": {
"$ref": "#/components/schemas/FormatConversion_6435353034"
},
"height": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"maxSize": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"quality": {
"description": "The quality in percent of the converted file.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"unit": {
"description": "A length unit.",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
},
"width": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "DownloadFormat",
"type": "object"
},
"DownloadFormatBasic": {
"properties": {
"colorspace": {
"description": "The colorspace of a media file.",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"density": {
"description": "The density of the picture.",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
},
"formatConversion": {
"$ref": "#/components/schemas/FormatConversion_6435353034"
},
"height": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"maxSize": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"quality": {
"description": "The quality in percent of the converted file.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"unit": {
"description": "A length unit.",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
},
"width": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "DownloadFormatBasic",
"type": "object"
},
"DownloadFormatInfo": {
"description": "The info about a download format.",
"example": {
"id": 5,
"name": "Instagram"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DownloadFormatInfo",
"type": "object"
},
"DownloadFormatModifiedColorspace": {
"properties": {
"newColorspace": {
"description": "The new colorspace.",
"enum": [
"CMYK",
"GRAY",
"RGB",
"RGB"
],
"example": "RGB",
"title": "Colorspace",
"type": "string"
},
"oldColorspace": {
"description": "The old colorspace.",
"enum": [
"CMYK",
"GRAY",
"RGB",
"RGB"
],
"example": "RGB",
"title": "Colorspace",
"type": "string"
}
},
"title": "DownloadFormatModifiedColorspace",
"type": "object"
},
"DownloadFormatModifiedDensity": {
"properties": {
"newDensity": {
"description": "The new density.",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
},
"oldDensity": {
"description": "The old density.",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
}
},
"title": "DownloadFormatModifiedDensity",
"type": "object"
},
"DownloadFormatModifiedFormatConversion": {
"properties": {
"newFormatConversion": {
"$ref": "#/components/schemas/FormatConversion"
},
"oldFormatConversion": {
"$ref": "#/components/schemas/FormatConversion_3434303634"
}
},
"title": "DownloadFormatModifiedFormatConversion",
"type": "object"
},
"DownloadFormatModifiedHeight": {
"properties": {
"newHeight": {
"description": "The new height.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldHeight": {
"description": "The old height.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "DownloadFormatModifiedHeight",
"type": "object"
},
"DownloadFormatModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DownloadFormatModifiedName",
"type": "object"
},
"DownloadFormatModifiedQuality": {
"properties": {
"newQuality": {
"description": "The new quality.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"oldQuality": {
"description": "The old quality.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
}
},
"title": "DownloadFormatModifiedQuality",
"type": "object"
},
"DownloadFormatModifiedResize": {
"properties": {
"newResize": {
"description": "The new resize.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldResize": {
"description": "The old resize.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "DownloadFormatModifiedResize",
"type": "object"
},
"DownloadFormatModifiedResizeUnit": {
"properties": {
"newResizeUnit": {
"description": "The new resizeUnit.",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
},
"oldResizeUnit": {
"description": "The old resizeUnit.",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
}
},
"title": "DownloadFormatModifiedResizeUnit",
"type": "object"
},
"DownloadFormatModifiedWidth": {
"properties": {
"newWidth": {
"description": "The new width.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldWidth": {
"description": "The old width.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "DownloadFormatModifiedWidth",
"type": "object"
},
"DownloadFormatTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "DownloadFormatTranslationModifiedLanguage",
"type": "object"
},
"DownloadFormatTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DownloadFormatTranslationModifiedName",
"type": "object"
},
"DownloadInfo": {
"description": "The information of the download.",
"example": {
"appliedWatermark": false,
"colorspace": "RGB",
"cropSector": {
"Height": 345,
"OffsetX": 234,
"OffsetY": 123,
"Width": 456
},
"destinationDensity": 300,
"destinationQuality": 90,
"destinationRotation": 180,
"downloadFormatType": "preview",
"duration": "1 s",
"fetchedFromCache": false,
"fileExtension": "jpg",
"fileSize": 204800,
"height": 1080,
"successful": true,
"width": 1920,
"wroteMetadata": true
},
"properties": {
"appliedWatermark": {
"type": "boolean"
},
"colorspace": {
"description": "The colorspace of the image or video.",
"enum": [
"CMYK",
"GRAY",
"RGB",
"RGB"
],
"example": "RGB",
"title": "Colorspace",
"type": "string"
},
"cropSector": {
"$ref": "#/components/schemas/CropSector_6463376534"
},
"destinationDensity": {
"description": "The density of the picture.",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
},
"destinationQuality": {
"description": "The quality in percent of the converted file.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"destinationRotation": {
"description": "The rotation in degrees of the converted file (0, 90, 180 or 270).",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"downloadFormatType": {
"description": "DownloadFormatType is a type for the download format of a media file.",
"enum": [
"free",
"original",
"preset",
"preview"
],
"example": "original",
"title": "DownloadFormatType",
"type": "string"
},
"duration": {
"description": "A datetime duration. If no time unit is specified, seconds are assumed.",
"example": "1 s",
"title": "Duration",
"type": "string"
},
"fetchedFromCache": {
"type": "boolean"
},
"fileExtension": {
"description": "FileExtension is an Entity for a FileExtension. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileExtension are replaced by one whitespace.",
"example": "JPG",
"title": "FileExtension",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"successful": {
"type": "boolean"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"wroteMetadata": {
"type": "boolean"
}
},
"title": "DownloadInfo",
"type": "object"
},
"DownloadModifiedDownloadFormatID": {
"properties": {
"newDownloadFormatID": {
"description": "The new downloadFormatID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldDownloadFormatID": {
"description": "The old downloadFormatID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "DownloadModifiedDownloadFormatID",
"type": "object"
},
"DownloadModifiedFileIDsAdded": {
"properties": {
"fileIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6431616537"
}
},
"title": "DownloadModifiedFileIDsAdded",
"type": "object"
},
"DownloadModifiedFileIDsRemoved": {
"properties": {
"fileIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3263613436"
}
},
"title": "DownloadModifiedFileIDsRemoved",
"type": "object"
},
"DownloadModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "DownloadModifiedUserID",
"type": "object"
},
"DownloadModifiedUserName": {
"properties": {
"newUserName": {
"description": "The new userName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldUserName": {
"description": "The old userName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "DownloadModifiedUserName",
"type": "object"
},
"EmailCustomTemplateModifiedBody": {
"properties": {
"newBody": {
"description": "The new body.",
"type": "string"
},
"oldBody": {
"description": "The old body.",
"type": "string"
}
},
"title": "EmailCustomTemplateModifiedBody",
"type": "object"
},
"EmailCustomTemplateModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
}
},
"title": "EmailCustomTemplateModifiedLanguage",
"type": "object"
},
"EmailCustomTemplateModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "EmailCustomTemplateModifiedName",
"type": "object"
},
"EmailCustomTemplateModifiedSubject": {
"properties": {
"newSubject": {
"description": "The new subject.",
"type": "string"
},
"oldSubject": {
"description": "The old subject.",
"type": "string"
}
},
"title": "EmailCustomTemplateModifiedSubject",
"type": "object"
},
"EmailCustomTemplateModifiedType": {
"properties": {
"newType": {
"description": "The new type.",
"enum": [
"ExternalSharedCollectionOpened",
"ExternalSharedMedia",
"GlobalUser",
"MessageCenter",
"PortalConfirmation",
"PortalCredentials",
"PortalNewRegistration",
"PortalResetPassword",
"Reporting",
"ResetPassword",
"SMTPTest",
"StorageLimitAlmostExceeded",
"StorageLimitExceeded",
"UploadLink"
],
"example": "ExternalSharedCollectionOpened",
"title": "EmailTemplatesType",
"type": "string"
},
"oldType": {
"description": "The old type.",
"enum": [
"ExternalSharedCollectionOpened",
"ExternalSharedMedia",
"GlobalUser",
"MessageCenter",
"PortalConfirmation",
"PortalCredentials",
"PortalNewRegistration",
"PortalResetPassword",
"Reporting",
"ResetPassword",
"SMTPTest",
"StorageLimitAlmostExceeded",
"StorageLimitExceeded",
"UploadLink"
],
"example": "ExternalSharedCollectionOpened",
"title": "EmailTemplatesType",
"type": "string"
}
},
"title": "EmailCustomTemplateModifiedType",
"type": "object"
},
"EmailLanguage": {
"description": "A email language.",
"example": {
"email": "technik@pixx.io",
"language": "de"
},
"properties": {
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"language": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "EmailLanguage",
"type": "object"
},
"Event": {
"properties": {
"action": {
"description": "An Event action",
"enum": [
"attempted",
"created",
"deleted",
"downloaded",
"indexed",
"replaced",
"replacedPreviewFile",
"restoredPreviewFile",
"sharedExternally",
"sharedInternally",
"updated",
"viewed"
],
"example": "viewed",
"title": "EventAction",
"type": "string"
},
"applicationKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"applicationName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"cause": {
"description": "The cause of an event.",
"enum": [
"batchTenant",
"clarifaiScan",
"clearDownloadCache",
"computeGroupsAzureActiveDirectory",
"createAPIKey",
"createAdministrationServer",
"createAssetNavigator",
"createAssetNavigatorCategory",
"createAzureActiveDirectory",
"createCollection",
"createComment",
"createCustomMetadata",
"createDirectLink",
"createDirectory",
"createDownload",
"createDownloadFormat",
"createEmailCustomTemplate",
"createExternalShare",
"createExternalSharesComment",
"createExternalSharesUpvote",
"createFile",
"createFileState",
"createFilter",
"createHost",
"createIdentityProvider",
"createImportantMetadata",
"createKeyword",
"createLicense",
"createLicenseRelease",
"createMetadataField",
"createModel",
"createModelRelease",
"createPackage",
"createPackagePortal",
"createPermissionGroup",
"createPlugin",
"createPortal",
"createPortalAssetNavigator",
"createPortalPage",
"createPortalUser",
"createProperty",
"createPropertyRelease",
"createReport",
"createSpace",
"createSpaceNavigationFooter",
"createSpaceNavigationFooterLink",
"createSpaceNavigationHeader",
"createSpaceNavigationHeaderCategory",
"createSpacePage",
"createSpacePageTemplate",
"createSpaceTemplate",
"createStandardMetadata",
"createSystem",
"createTrash",
"createUploadLink",
"createUser",
"createUserTracking",
"createVariantStack",
"createVersionStackFile",
"createWebhook",
"deleteAPIKey",
"deleteAdministrationServer",
"deleteAssetNavigator",
"deleteAssetNavigatorCategory",
"deleteAzureActiveDirectory",
"deleteCollection",
"deleteComment",
"deleteCustomMetadata",
"deleteDirectLink",
"deleteDirectory",
"deleteDownload",
"deleteDownloadFormat",
"deleteDuplicateFile",
"deleteEmailCustomTemplate",
"deleteExternalShare",
"deleteExternalSharesComment",
"deleteExternalSharesUpvote",
"deleteFile",
"deleteFileState",
"deleteFilter",
"deleteHost",
"deleteIdentityProvider",
"deleteImportantMetadata",
"deleteKeyword",
"deleteLicense",
"deleteLicenseRelease",
"deleteMetadataField",
"deleteModel",
"deleteModelRelease",
"deletePackage",
"deletePackagePortal",
"deletePermissionGroup",
"deletePlugin",
"deletePortal",
"deletePortalAssetNavigator",
"deletePortalPage",
"deletePortalUser",
"deleteProperty",
"deletePropertyRelease",
"deleteReport",
"deleteSettingsClarifai",
"deleteSettingsDownloadCache",
"deleteSettingsOpenStreetMap",
"deleteSettingsSMTPServer",
"deleteSpace",
"deleteSpaceNavigationFooter",
"deleteSpaceNavigationFooterLink",
"deleteSpaceNavigationHeader",
"deleteSpaceNavigationHeaderCategory",
"deleteSpacePage",
"deleteSpacePageTemplate",
"deleteSpaceTemplate",
"deleteStandardMetadata",
"deleteSynonym",
"deleteSystem",
"deleteTrash",
"deleteUploadLink",
"deleteUser",
"deleteUserTracking",
"deleteVariantStack",
"deleteWebhook",
"doubleOptInConfirmPortalUser",
"downloadFile",
"featureActivate",
"featureDeactivate",
"fileModifiedFaces",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedRecognizedText",
"indexFinished",
"ldapComputeGroups",
"ldapSync",
"loginAttempted",
"messageQueueJobFinished",
"metadataFieldEditTypeNormalization",
"replacePreviewFileFile",
"resetPasswordConfirmPortalUser",
"resetPasswordConfirmUser",
"restorePreviewFileFile",
"scanFilesClarifai",
"scanFilesOpenStreetMap",
"syncAzureActiveDirectory",
"testController",
"updateAPIKey",
"updateAdministrationServer",
"updateAssetNavigator",
"updateAssetNavigatorCategory",
"updateAssetNavigatorCategoryTranslation",
"updateAzureActiveDirectory",
"updateCollection",
"updateCollectionTranslation",
"updateCustomMetadata",
"updateCustomMetadataOption",
"updateDefaultMetadataField",
"updateDirectLink",
"updateDirectory",
"updateDownload",
"updateDownloadFormat",
"updateDownloadFormatTranslation",
"updateEmailCustomTemplate",
"updateExternalShare",
"updateFile",
"updateFileState",
"updateFilter",
"updateHost",
"updateIdentityProvider",
"updateImportantMetadata",
"updateLicense",
"updateLicenseRelease",
"updateLicenseReleaseTranslation",
"updateMainVersionFile",
"updateMessageCenter",
"updateMessages",
"updateMetadataField",
"updateModel",
"updateModelRelease",
"updateModelReleaseTranslation",
"updatePackage",
"updatePackagePortal",
"updatePermissionGroup",
"updatePlugin",
"updatePortal",
"updatePortalAssetNavigator",
"updatePortalCollection",
"updatePortalPage",
"updatePortalPageTranslation",
"updatePortalTranslation",
"updatePortalUser",
"updateProperty",
"updatePropertyRelease",
"updatePropertyReleaseTranslation",
"updateReport",
"updateSettingsClarifai",
"updateSettingsDesign",
"updateSettingsDownloadCache",
"updateSettingsGeneral",
"updateSettingsOpenStreetMap",
"updateSettingsSMTPServer",
"updateSettingsWatermark",
"updateSpace",
"updateSpaceNavigationFooter",
"updateSpaceNavigationFooterLink",
"updateSpaceNavigationHeader",
"updateSpaceNavigationHeaderCategory",
"updateSpacePage",
"updateSpacePageTemplate",
"updateSpaceTemplate",
"updateStandardMetadata",
"updateSystem",
"updateTrash",
"updateUploadLink",
"updateUser",
"updateUserTracking",
"updateVariantStack",
"updateWebhook",
"uploadCSVKeyword",
"uploadCSVSynonym",
"uploadFile",
"viewExternalShare"
],
"example": "createFile",
"title": "EventCause",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"data": {
"$ref": "#/components/schemas/EventData"
},
"eventKey": {
"description": "EventKey represents the key of an event.",
"enum": [
"apiKeyCreated",
"apiKeyDeleted",
"apiKeyModifiedIPRangeAdded",
"apiKeyModifiedIPRangeRemoved",
"apiKeyModifiedIsActive",
"apiKeyModifiedName",
"apiKeyModifiedScopeID",
"apiKeyModifiedUserID",
"assetNavigatorCategoryCreated",
"assetNavigatorCategoryDeleted",
"assetNavigatorCategoryModifiedMetadataFieldID",
"assetNavigatorCategoryModifiedOrder",
"assetNavigatorCategoryTranslationCreated",
"assetNavigatorCategoryTranslationModifiedLanguage",
"assetNavigatorCategoryTranslationModifiedName",
"assetNavigatorCreated",
"assetNavigatorDeleted",
"assetNavigatorModifiedAssetNavigatorCategory",
"assetNavigatorModifiedDescription",
"assetNavigatorModifiedName",
"azureActiveDirectoryCreated",
"azureActiveDirectoryDeleted",
"azureActiveDirectoryModifiedClientID",
"azureActiveDirectoryModifiedClientSecret",
"azureActiveDirectoryModifiedDeleteMode",
"azureActiveDirectoryModifiedGroupUpdated",
"azureActiveDirectoryModifiedGroupsActivated",
"azureActiveDirectoryModifiedGroupsAdded",
"azureActiveDirectoryModifiedGroupsDeactivated",
"azureActiveDirectoryModifiedGroupsRemoved",
"azureActiveDirectoryModifiedIPRangeAdded",
"azureActiveDirectoryModifiedIPRangeRemoved",
"azureActiveDirectoryModifiedName",
"azureActiveDirectoryModifiedNewUserDataOwner",
"azureActiveDirectoryModifiedRecursive",
"azureActiveDirectoryModifiedSyncTime",
"azureActiveDirectoryModifiedTenantID",
"collectionCreated",
"collectionDeleted",
"collectionModifiedAssetNavigatorID",
"collectionModifiedFilesAdded",
"collectionModifiedFilesCommented",
"collectionModifiedFilesRemoved",
"collectionModifiedPreviewFileIDs",
"collectionModifiedUserID",
"collectionSharedExternally",
"collectionSharedInternally",
"collectionTranslationCreated",
"collectionTranslationDeleted",
"collectionTranslationModifiedDescription",
"collectionTranslationModifiedLanguage",
"collectionTranslationModifiedName",
"collectionUnsharedInternally",
"commentCreated",
"commentDeleted",
"customMetadataCreated",
"customMetadataDeleted",
"customMetadataLanguagesCreated",
"customMetadataLanguagesDeleted",
"customMetadataLanguagesModifiedName",
"customMetadataModifiedParentConditionCustomMetadataID",
"customMetadataModifiedParentConditionCustomMetadataOptionIDs",
"customMetadataOptionLanguagesCreated",
"customMetadataOptionLanguagesDeleted",
"customMetadataOptionLanguagesModifiedName",
"customMetadataOptionsCreated",
"customMetadataOptionsDeleted",
"customMetadataOptionsModifiedOrder",
"customMetadataParentConditionCreated",
"customMetadataParentConditionDeleted",
"directLinkCreated",
"directLinkDeleted",
"directLinkModifiedDownloadFormatID",
"directLinkModifiedFileID",
"directLinkModifiedFileName",
"directLinkModifiedFileSize",
"directoryCreated",
"directoryDeleted",
"directoryModifiedName",
"directoryModifiedParentDirectoryID",
"downloadCreated",
"downloadDeleted",
"downloadFormatCreated",
"downloadFormatDeleted",
"downloadFormatModifiedColorspace",
"downloadFormatModifiedDensity",
"downloadFormatModifiedFormatConversion",
"downloadFormatModifiedHeight",
"downloadFormatModifiedName",
"downloadFormatModifiedQuality",
"downloadFormatModifiedResize",
"downloadFormatModifiedResizeUnit",
"downloadFormatModifiedWidth",
"downloadFormatTranslationCreated",
"downloadFormatTranslationModifiedLanguage",
"downloadFormatTranslationModifiedName",
"downloadModifiedDownloadFormatID",
"downloadModifiedFileIDsAdded",
"downloadModifiedFileIDsRemoved",
"downloadModifiedUserID",
"downloadModifiedUserName",
"duplicateFileCreated",
"duplicateFileDeleted",
"emailCustomTemplateCreated",
"emailCustomTemplateDeleted",
"emailCustomTemplateModifiedBody",
"emailCustomTemplateModifiedLanguage",
"emailCustomTemplateModifiedName",
"emailCustomTemplateModifiedSubject",
"emailCustomTemplateModifiedType",
"externalShareCreated",
"externalShareDeleted",
"externalShareModifiedAllowComments",
"externalShareModifiedAllowDownloads",
"externalShareModifiedAllowUpvotes",
"externalShareModifiedDescription",
"externalShareModifiedDownloadFormatsAdded",
"externalShareModifiedDownloadFormatsRemoved",
"externalShareModifiedEmailsAdded",
"externalShareModifiedFileDetailsAdded",
"externalShareModifiedFileDetailsRemoved",
"externalShareModifiedFilesAdded",
"externalShareModifiedFilesRemoved",
"externalShareModifiedForceDownloadProof",
"externalShareModifiedForceWatermark",
"externalShareModifiedHasDownloadFormatFree",
"externalShareModifiedHasDownloadFormatOriginal",
"externalShareModifiedHasDownloadFormatPreview",
"externalShareModifiedIsDisabled",
"externalShareModifiedMediaViewsAdded",
"externalShareModifiedMediaViewsRemoved",
"externalShareModifiedName",
"externalShareModifiedNotificationText",
"externalShareModifiedPassword",
"externalShareModifiedTermsOfUse",
"externalShareModifiedUserID",
"externalShareModifiedValidityPeriod",
"externalShareViewed",
"externalSharesCommentCreated",
"externalSharesCommentDeleted",
"externalSharesUpvoteCreated",
"externalSharesUpvoteDeleted",
"fileCreated",
"fileDeleted",
"fileDeletedDuplicate",
"fileDownloaded",
"fileModifiedCollectionIDsAdded",
"fileModifiedCollectionIDsRemoved",
"fileModifiedCreateDate",
"fileModifiedCreator",
"fileModifiedDescription",
"fileModifiedDirectoryIDPath",
"fileModifiedExternalShareIDsAdded",
"fileModifiedExternalShareIDsRemoved",
"fileModifiedFaces",
"fileModifiedFileName",
"fileModifiedFileStateID",
"fileModifiedIsCheckedOut",
"fileModifiedIsDownloadLocked",
"fileModifiedKeywordsAdded",
"fileModifiedKeywordsDeleted",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedLanguageCodesAdded",
"fileModifiedLanguageCodesRemoved",
"fileModifiedLicenseFilesAdded",
"fileModifiedLicenseFilesDeleted",
"fileModifiedLocation",
"fileModifiedMainVersionFileID",
"fileModifiedMarkedUserIDsAdded",
"fileModifiedMarkedUserIDsRemoved",
"fileModifiedMetadataFieldDate",
"fileModifiedMetadataFieldFocalPoint",
"fileModifiedMetadataFieldLanguagesAdded",
"fileModifiedMetadataFieldLanguagesDeleted",
"fileModifiedMetadataFieldLocation",
"fileModifiedMetadataFieldMultiSelectionsAdded",
"fileModifiedMetadataFieldMultiSelectionsDeleted",
"fileModifiedMetadataFieldOrientation",
"fileModifiedMetadataFieldSelection",
"fileModifiedMetadataFieldText",
"fileModifiedMetadataFieldTruncate",
"fileModifiedModelFilesAdded",
"fileModifiedModelFilesDeleted",
"fileModifiedPropertyFilesAdded",
"fileModifiedPropertyFilesDeleted",
"fileModifiedRating",
"fileModifiedRecognizedText",
"fileModifiedRotation",
"fileModifiedSubject",
"fileModifiedUploadDate",
"fileModifiedUploadLink",
"fileModifiedUserID",
"fileModifiedVariantStack",
"fileReplaced",
"fileReplacedPreviewFile",
"fileRestoredPreviewFile",
"fileStateCreated",
"fileStateDeleted",
"fileStateModifiedColor",
"fileStateModifiedDescription",
"fileStateModifiedForceComment",
"fileStateModifiedIsArchive",
"fileStateModifiedName",
"fileStateModifiedOrder",
"filesCustomFieldCreated",
"filesCustomFieldDeleted",
"filesCustomFieldModifiedValue",
"filesCustomFieldModifiedValueCustomFieldsOptionID",
"filesCustomFieldModifiedValueCustomFieldsOptionIDs",
"filterCreated",
"filterDeleted",
"filterModifiedFilter",
"filterModifiedName",
"filterModifiedUserID",
"generalSettingsModifiedAllowConcurrentLogin",
"generalSettingsModifiedAllowDuplicates",
"generalSettingsModifiedCheckSessionFiles",
"generalSettingsModifiedDailyAPILimit",
"generalSettingsModifiedDataPrivacyText",
"generalSettingsModifiedDataPrivacyURL",
"generalSettingsModifiedDefaultLanguageCodesAdded",
"generalSettingsModifiedDefaultLanguageCodesRemoved",
"generalSettingsModifiedDirectoriesInMediaview",
"generalSettingsModifiedDownloadCacheSize",
"generalSettingsModifiedDownloadCacheStoreCroppedFiles",
"generalSettingsModifiedDownloadCacheTime",
"generalSettingsModifiedDownloadLockedText",
"generalSettingsModifiedEnableForgotPasswordOption",
"generalSettingsModifiedExternalShareAlias",
"generalSettingsModifiedFaceRecognition",
"generalSettingsModifiedGeneralUploadText",
"generalSettingsModifiedKeywordUploadText",
"generalSettingsModifiedKeywordsBoundToPermissionGroups",
"generalSettingsModifiedLegalNoticeText",
"generalSettingsModifiedLegalNoticeURL",
"generalSettingsModifiedMetadataFieldsOrder",
"generalSettingsModifiedPasswordSecurityLevel",
"generalSettingsModifiedSecondAPILimit",
"generalSettingsModifiedSemanticSearch",
"generalSettingsModifiedSessionTimeout",
"generalSettingsModifiedShowChat",
"generalSettingsModifiedShowFileOwner",
"generalSettingsModifiedShowUnimportantMetadataFields",
"generalSettingsModifiedSmartTagging",
"generalSettingsModifiedSubjectExtractionType",
"generalSettingsModifiedSystemLanguage",
"generalSettingsModifiedTextRecognition",
"generalSettingsModifiedTranslationLanguagesAdded",
"generalSettingsModifiedTranslationLanguagesRemoved",
"generalSettingsModifiedTwoFactorAuth",
"generalSettingsModifiedUseAlreadyIncludedKeywords",
"generalSettingsModifiedVideoForceConversion",
"generalSettingsModifiedVideoMaxDuration",
"generalSettingsModifiedVideoMaxSize",
"identityProviderCreated",
"identityProviderDeleted",
"identityProviderModifiedAuthorizationEndpoint",
"identityProviderModifiedClientID",
"identityProviderModifiedClientSecret",
"identityProviderModifiedIsActive",
"identityProviderModifiedMetadataEndpoint",
"identityProviderModifiedName",
"identityProviderModifiedTokenEndpoint",
"identityProviderModifiedUserEndpoint",
"identityProviderModifiedUserField",
"importantMetadataCreated",
"importantMetadataDeleted",
"importantMetadataModifiedIsEditable",
"importantMetadataModifiedIsIndexed",
"importantMetadataModifiedOrder",
"keywordCreated",
"keywordDeleted",
"keywordModifiedPermissionGroupIDsAdded",
"keywordModifiedPermissionGroupIDsRemoved",
"licenseCreated",
"licenseDeleted",
"licenseFileCreated",
"licenseFileDeleted",
"licenseFileModifiedColor",
"licenseFileModifiedCreateDate",
"licenseFileModifiedFile",
"licenseFileModifiedInfosAdded",
"licenseFileModifiedInfosRemoved",
"licenseFileModifiedName",
"licenseFileModifiedShowFile",
"licenseFileModifiedShowWarningMessage",
"licenseFileModifiedWarningMessage",
"licenseModifiedProvider",
"licenseReleaseDataTranslationCreated",
"licenseReleaseDataTranslationModifiedContentName",
"licenseReleaseDataTranslationModifiedContentValue",
"licenseReleaseDataTranslationModifiedLanguage",
"licenseReleaseTranslationCreated",
"licenseReleaseTranslationModifiedLanguage",
"licenseReleaseTranslationModifiedName",
"loginAttempted",
"manageAdministrationServerCreated",
"manageAdministrationServerDeleted",
"manageAdministrationServerModifiedAdministrationServerIdentifier",
"manageAdministrationServerModifiedAllowsPushConnection",
"manageAdministrationServerModifiedName",
"manageAdministrationServerModifiedURL",
"manageBatchTenantIndexedFinished",
"manageBatchTenantIndexedStarted",
"manageFeatureActivated",
"manageFeatureDeactivated",
"manageHostCreated",
"manageHostDeleted",
"manageHostModifiedHostName",
"manageHostModifiedHostType",
"manageHostModifiedIsPortal",
"manageHostModifiedSystemIdentifier",
"managePackageCreated",
"managePackageDeleted",
"managePackageModifiedAvailablePluginsAdded",
"managePackageModifiedAvailablePluginsRemoved",
"managePackageModifiedBookingEnabled",
"managePackageModifiedCustomerValue",
"managePackageModifiedDailyAPILimit",
"managePackageModifiedDiskSpacePerUser",
"managePackageModifiedFeature",
"managePackageModifiedHideAllPackages",
"managePackageModifiedHideCustomerGroupPackages",
"managePackageModifiedHideUniversalPackages",
"managePackageModifiedIncludedDiskspace",
"managePackageModifiedName",
"managePackageModifiedPluginLimit",
"managePackageModifiedSecondAPILimit",
"managePackageModifiedUnlockedCustomerGroupsAdded",
"managePackageModifiedUnlockedCustomerGroupsRemoved",
"managePackageModifiedUnlockedSystemIdentifiersAdded",
"managePackageModifiedUnlockedSystemIdentifiersRemoved",
"managePackageModifiedUnlockedUniversal",
"managePackagePortalCreated",
"managePackagePortalDeleted",
"managePackagePortalFeaturesModified",
"managePackagePortalModifiedName",
"managePluginCreated",
"managePluginDeleted",
"managePluginModifiedApplicationKey",
"managePluginModifiedCustomerIdentifier",
"managePluginModifiedIsActive",
"managePluginModifiedName",
"managePluginModifiedUnlockedUniversal",
"manageServerRecreatedConfig",
"manageServerReloaded",
"manageSystemCreated",
"manageSystemDeleted",
"manageSystemModifiedAdditionalDiskSpaceGigaByte",
"manageSystemModifiedAdministrationServerIdentifier",
"manageSystemModifiedCustomUnlockedFeatures",
"manageSystemModifiedCustomUnlockedFeaturesAdded",
"manageSystemModifiedCustomUnlockedFeaturesRemoved",
"manageSystemModifiedCustomerGroupsAdded",
"manageSystemModifiedCustomerGroupsRemoved",
"manageSystemModifiedCustomerIdentifier",
"manageSystemModifiedDataPath",
"manageSystemModifiedDatabaseAlias",
"manageSystemModifiedDomainName",
"manageSystemModifiedExpirationDate",
"manageSystemModifiedHostName",
"manageSystemModifiedInstallationType",
"manageSystemModifiedIsCurrentlyUpdating",
"manageSystemModifiedIsPaused",
"manageSystemModifiedLastSentMail",
"manageSystemModifiedMediaPortalLimit",
"manageSystemModifiedName",
"manageSystemModifiedOperatingSystem",
"manageSystemModifiedPackageIdentifier",
"manageSystemModifiedPixxioVersion",
"manageSystemModifiedReadOnlyUserLimit",
"manageSystemModifiedReceiveBetaUpdates",
"manageSystemModifiedReceiveUpdates",
"manageSystemModifiedSQLDatabase",
"manageSystemModifiedSQLHost",
"manageSystemModifiedSQLPassword",
"manageSystemModifiedSQLUserName",
"manageSystemModifiedUDID",
"manageSystemModifiedUserLimit",
"manageUnlockedPluginCreated",
"manageUnlockedPluginDeleted",
"manageUnlockedPluginModifiedRedirectURI",
"manageUnlockedPluginModifiedSystemIdentifier",
"messageCenterCreated",
"messageCenterDeleted",
"messageCenterModifiedCollectionsAdded",
"messageCenterModifiedCollectionsRemoved",
"messageCenterModifiedNotificationByApplication",
"messageCenterModifiedNotificationByEmail",
"messageCenterModifiedNotificationDayTime",
"messageCenterModifiedNotificationInterval",
"messageCenterModifiedNotificationMonthDay",
"messageCenterModifiedNotificationWeekDay",
"messageCenterModifiedNotifyCollectionDeleted",
"messageCenterModifiedNotifyCollectionEdited",
"messageCenterModifiedNotifyCollectionMessagingWithoutSubscription",
"messageCenterModifiedNotifyCollectionShared",
"messageCenterModifiedNotifyCollectionSharedInternalWithMe",
"messageCenterModifiedNotifyExternalSharedCollectionOpened",
"metadataFieldCreated",
"metadataFieldDeleted",
"metadataFieldModifiedEditType",
"metadataFieldModifiedIndexedForSearchTerm",
"metadataFieldModifiedIsImportant",
"metadataFieldModifiedIsSearchable",
"metadataFieldModifiedName",
"metadataFieldModifiedSelectionTermsAdded",
"metadataFieldModifiedSelectionTermsRemoved",
"metadataFieldModifiedSelectionTermsRenamed",
"modelCreated",
"modelDeleted",
"modelFileCreated",
"modelFileDeleted",
"modelFileModifiedColor",
"modelFileModifiedCreateDate",
"modelFileModifiedFile",
"modelFileModifiedName",
"modelFileModifiedShowFile",
"modelFileModifiedShowWarningMessage",
"modelFileModifiedWarningMessage",
"modelModifiedBirthDate",
"modelModifiedEmail",
"modelModifiedFirstName",
"modelModifiedLastName",
"modelReleaseTranslationCreated",
"modelReleaseTranslationModifiedLanguage",
"modelReleaseTranslationModifiedName",
"newFileCreated",
"permissionGroupCreated",
"permissionGroupDeleted",
"permissionGroupModifiedCommentFiles",
"permissionGroupModifiedCreateCollections",
"permissionGroupModifiedCreateDirectoriesInHomeDirectory",
"permissionGroupModifiedCreateKeywords",
"permissionGroupModifiedCreatePortals",
"permissionGroupModifiedCreateUploadLinks",
"permissionGroupModifiedDefaultUploadFileState",
"permissionGroupModifiedDeleteForeignCollections",
"permissionGroupModifiedDeleteForeignFiles",
"permissionGroupModifiedDeleteOwnCollections",
"permissionGroupModifiedDeleteOwnFiles",
"permissionGroupModifiedDirectoryIDsToEditAdded",
"permissionGroupModifiedDirectoryIDsToEditAll",
"permissionGroupModifiedDirectoryIDsToEditRemoved",
"permissionGroupModifiedDirectoryIDsToModifyAdded",
"permissionGroupModifiedDirectoryIDsToModifyAll",
"permissionGroupModifiedDirectoryIDsToModifyRemoved",
"permissionGroupModifiedDirectoryIDsToShowAdded",
"permissionGroupModifiedDirectoryIDsToShowAll",
"permissionGroupModifiedDirectoryIDsToShowRemoved",
"permissionGroupModifiedDirectoryIDsToUploadAdded",
"permissionGroupModifiedDirectoryIDsToUploadAll",
"permissionGroupModifiedDirectoryIDsToUploadRemoved",
"permissionGroupModifiedDownloadFormatIDsAdded",
"permissionGroupModifiedDownloadFormatIDsRemoved",
"permissionGroupModifiedEditDesign",
"permissionGroupModifiedEditFilesInHomeDirectory",
"permissionGroupModifiedEditFilesInInternalSharedCollections",
"permissionGroupModifiedEditForeignCollections",
"permissionGroupModifiedEditForeignFiles",
"permissionGroupModifiedEditLicenses",
"permissionGroupModifiedEditUsers",
"permissionGroupModifiedFileStatesToAssignAdded",
"permissionGroupModifiedFileStatesToAssignAll",
"permissionGroupModifiedFileStatesToAssignRemoved",
"permissionGroupModifiedFileStatesToShowAdded",
"permissionGroupModifiedFileStatesToShowAll",
"permissionGroupModifiedFileStatesToShowRemoved",
"permissionGroupModifiedForceDownloadProof",
"permissionGroupModifiedForceExportProof",
"permissionGroupModifiedForceWatermark",
"permissionGroupModifiedHasDownloadFormatFree",
"permissionGroupModifiedHasDownloadFormatOriginal",
"permissionGroupModifiedHasDownloadFormatPreview",
"permissionGroupModifiedIsAdmin",
"permissionGroupModifiedIsExternal",
"permissionGroupModifiedLinked",
"permissionGroupModifiedName",
"permissionGroupModifiedShareCollectionsExternal",
"permissionGroupModifiedShareCollectionsInternal",
"permissionGroupModifiedShareCollectionsNetwork",
"permissionGroupModifiedShareFilesNetwork",
"permissionGroupModifiedShowAllCustomDownloadFormats",
"permissionGroupModifiedUnlinked",
"permissionGroupModifiedUploadFilesToHomeDirectory",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsAdded",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsRemoved",
"permissionGroupModifiedUploadObligationsAdded",
"permissionGroupModifiedUploadObligationsRemoved",
"portalCollectionModifiedIsProtected",
"portalCollectionModifiedOrder",
"portalCreated",
"portalDeleted",
"portalModifiedActivateUserAutomatically",
"portalModifiedAddShadowToFont",
"portalModifiedAutomaticallyActivatedDomainsAdded",
"portalModifiedAutomaticallyActivatedDomainsRemoved",
"portalModifiedBackgroundColor",
"portalModifiedBrandURL",
"portalModifiedBrandingLogoImage",
"portalModifiedCollectionAssetNavigator",
"portalModifiedCollectionsAdded",
"portalModifiedCollectionsRemoved",
"portalModifiedCookieLinkPrivacyPage",
"portalModifiedCookiePlacement",
"portalModifiedCustomMetadataIDsAdded",
"portalModifiedCustomMetadataIDsRemoved",
"portalModifiedDefaultMetadataFieldsAdded",
"portalModifiedDefaultMetadataFieldsRemoved",
"portalModifiedDownloadFormatsAdded",
"portalModifiedDownloadFormatsRemoved",
"portalModifiedEmailReceiver",
"portalModifiedFilterOptionsAdded",
"portalModifiedFilterOptionsRemoved",
"portalModifiedForceDownloadProof",
"portalModifiedForceWatermark",
"portalModifiedGeneralPassword",
"portalModifiedHasUserRegistration",
"portalModifiedHasWhitelabel",
"portalModifiedHeroArrowColor",
"portalModifiedHeroBannerImage",
"portalModifiedHeroFontColor",
"portalModifiedHeroLogoColor",
"portalModifiedHeroLogoImage",
"portalModifiedHostNames",
"portalModifiedIsActive",
"portalModifiedLandingPageOptions",
"portalModifiedLanguagesAdded",
"portalModifiedLanguagesRemoved",
"portalModifiedLicenseReleaseIDsAdded",
"portalModifiedLicenseReleaseIDsRemoved",
"portalModifiedMainHostName",
"portalModifiedMediaViewsAdded",
"portalModifiedMediaViewsRemoved",
"portalModifiedModelReleaseIDsAdded",
"portalModifiedModelReleaseIDsRemoved",
"portalModifiedName",
"portalModifiedOriginalDownloadFormatTypesAdded",
"portalModifiedOriginalDownloadFormatTypesRemoved",
"portalModifiedPageName",
"portalModifiedPagePlacementsAdded",
"portalModifiedPagePlacementsRemoved",
"portalModifiedPageText",
"portalModifiedPageTranslationCreated",
"portalModifiedPageTranslationLanguage",
"portalModifiedPageTranslationName",
"portalModifiedPageTranslationText",
"portalModifiedPagesAdded",
"portalModifiedPagesRemoved",
"portalModifiedPreferredMode",
"portalModifiedPreferredTitle",
"portalModifiedPropertyReleaseIDsAdded",
"portalModifiedPropertyReleaseIDsRemoved",
"portalModifiedProtectedCollectionsAdded",
"portalModifiedProtectedCollectionsRemoved",
"portalModifiedRestrictAccess",
"portalModifiedSearchFieldsAdded",
"portalModifiedSearchFieldsRemoved",
"portalModifiedShowAllLicenseReleases",
"portalModifiedShowAllModelReleases",
"portalModifiedShowAllPropertyReleases",
"portalModifiedShowBorder",
"portalModifiedShowCookieInformation",
"portalModifiedShowCreateLinkToFileTab",
"portalModifiedShowFileType",
"portalModifiedShowLicenseReleaseFile",
"portalModifiedShowModelReleaseFile",
"portalModifiedShowPropertyReleaseFile",
"portalModifiedShowStartScreen",
"portalModifiedSortOptionsAdded",
"portalModifiedSortOptionsRemoved",
"portalModifiedStandardMetadataIDsAdded",
"portalModifiedStandardMetadataIDsRemoved",
"portalModifiedStartScreenText",
"portalModifiedTranslationCookieTextShort",
"portalModifiedTranslationFooterText",
"portalModifiedTranslationHeroSlogan",
"portalModifiedTranslationLanguage",
"portalModifiedUseSSO",
"portalModifiedUseSemanticSearch",
"portalModifiedUserCompany",
"portalModifiedUserDepartment",
"portalModifiedUserEmail",
"portalModifiedUserFirstName",
"portalModifiedUserIsActive",
"portalModifiedUserIsConfirmed",
"portalModifiedUserLanguage",
"portalModifiedUserLastName",
"portalModifiedUserPassword",
"portalModifiedUsersAdded",
"portalModifiedUsersRemoved",
"propertyCreated",
"propertyDeleted",
"propertyFileCreated",
"propertyFileDeleted",
"propertyFileModifiedColor",
"propertyFileModifiedCreateDate",
"propertyFileModifiedFile",
"propertyFileModifiedName",
"propertyFileModifiedShowFile",
"propertyFileModifiedShowWarningMessage",
"propertyFileModifiedWarningMessage",
"propertyModifiedAddress",
"propertyModifiedName",
"propertyModifiedOwner",
"propertyReleaseTranslationCreated",
"propertyReleaseTranslationModifiedLanguage",
"propertyReleaseTranslationModifiedName",
"reportCreated",
"reportDeleted",
"reportModifiedAdditionalText",
"reportModifiedDayInMonth",
"reportModifiedDayInWeek",
"reportModifiedDayTime",
"reportModifiedIsActive",
"reportModifiedName",
"reportModifiedReceiverEmailsAdded",
"reportModifiedReceiverEmailsRemoved",
"reportModifiedReportEventsAdded",
"reportModifiedReportEventsRemoved",
"reportModifiedReportEventsReplaced",
"reportModifiedReportInterval",
"reportModifiedReportWhenNoData",
"reportModifiedSendCSV",
"reportModifiedSendPDF",
"reportUpdated",
"settingsModifiedCustomJavaScript",
"settingsModifiedDateFormat",
"settingsModifiedExternalCollectionSyncHostName",
"settingsModifiedExternalCollectionSyncPassword",
"settingsModifiedExternalCollectionSyncUserName",
"settingsModifiedExternalCustomCss",
"settingsModifiedExternalShareHostName",
"settingsModifiedExternalSharePassword",
"settingsModifiedExternalShareUserName",
"settingsModifiedFaviconFile",
"settingsModifiedFaviconText",
"settingsModifiedFont",
"settingsModifiedLogoBigDark",
"settingsModifiedLogoBigLight",
"settingsModifiedLogoBootFile",
"settingsModifiedLogoDarkFile",
"settingsModifiedLogoFile",
"settingsModifiedLogoIconDark",
"settingsModifiedLogoIconLight",
"settingsModifiedLogoLink",
"settingsModifiedPrimaryColorDark",
"settingsModifiedPrimaryColorLight",
"settingsModifiedProxyHostName",
"settingsModifiedProxyPort",
"settingsModifiedSMTPHasSSL",
"settingsModifiedSMTPHostName",
"settingsModifiedSMTPPassword",
"settingsModifiedSMTPPort",
"settingsModifiedSMTPTransmitterEmail",
"settingsModifiedSMTPTransmitterName",
"settingsModifiedSMTPUseDefault",
"settingsModifiedSMTPUserName",
"settingsModifiedSecondaryColorDark",
"settingsModifiedSecondaryColorLight",
"settingsModifiedSloganStartscreen",
"settingsModifiedStartscreenFile",
"settingsModifiedUploadLinkBackgroundFile",
"settingsModifiedWatermarkFile",
"settingsModifiedWatermarkPositionIsBottomLeft",
"settingsModifiedWatermarkPositionIsBottomMiddle",
"settingsModifiedWatermarkPositionIsBottomRight",
"settingsModifiedWatermarkPositionIsCenter",
"settingsModifiedWatermarkPositionIsMiddleLeft",
"settingsModifiedWatermarkPositionIsMiddleRight",
"settingsModifiedWatermarkPositionIsUpperLeft",
"settingsModifiedWatermarkPositionIsUpperMiddle",
"settingsModifiedWatermarkPositionIsUpperRight",
"settingsModifiedWatermarkPositioningType",
"settingsModifiedWatermarkText",
"settingsModifiedWatermarkTransparency",
"settingsModifiedWatermarkWidthPercent",
"spaceCreated",
"spaceDeleted",
"spaceModifiedAutomaticallyActivatedDomainsAdded",
"spaceModifiedAutomaticallyActivatedDomainsRemoved",
"spaceModifiedCopyrightText",
"spaceModifiedCustomBodyFontFileID",
"spaceModifiedCustomHeadingsFontFileID",
"spaceModifiedCustomMetadataIDs",
"spaceModifiedCustomization",
"spaceModifiedDefaultMetadataFields",
"spaceModifiedDownloadFormatIDsAdded",
"spaceModifiedDownloadFormatIDsRemoved",
"spaceModifiedFaviconImage",
"spaceModifiedForceDownloadProof",
"spaceModifiedForceWatermark",
"spaceModifiedHostNames",
"spaceModifiedIsActive",
"spaceModifiedLanguagesAdded",
"spaceModifiedLanguagesRemoved",
"spaceModifiedLicenseReleaseIDs",
"spaceModifiedLoginBackgroundImage",
"spaceModifiedLoginHeadline",
"spaceModifiedLoginRequired",
"spaceModifiedLogoDarkImage",
"spaceModifiedLogoLightImage",
"spaceModifiedMainHostName",
"spaceModifiedModelReleaseIDs",
"spaceModifiedName",
"spaceModifiedNavigationFooter",
"spaceModifiedNavigationHeader",
"spaceModifiedOriginalDownloadFormatTypesAdded",
"spaceModifiedOriginalDownloadFormatTypesRemoved",
"spaceModifiedPermissionGroupIDsAdded",
"spaceModifiedPermissionGroupIDsRemoved",
"spaceModifiedPermissionGroupsAdded",
"spaceModifiedPermissionGroupsRemoved",
"spaceModifiedPreferredTitle",
"spaceModifiedPrimaryColor",
"spaceModifiedPropertyReleaseIDs",
"spaceModifiedSearchFieldsAdded",
"spaceModifiedSearchFieldsRemoved",
"spaceModifiedSecondaryColor",
"spaceModifiedShowAllLicenseReleases",
"spaceModifiedShowAllModelReleases",
"spaceModifiedShowAllPropertyReleases",
"spaceModifiedShowFileType",
"spaceModifiedShowLicenseReleaseFile",
"spaceModifiedShowModelReleaseFile",
"spaceModifiedShowPropertyReleaseFile",
"spaceModifiedShowTermsOfUse",
"spaceModifiedStandardMetadataIDs",
"spaceModifiedStartScreenPage",
"spaceModifiedTermsOfUse",
"spaceModifiedUseSSO",
"spaceModifiedUseSemanticSearch",
"spaceNavigationFooterCreated",
"spaceNavigationFooterDeleted",
"spaceNavigationFooterLinkCreated",
"spaceNavigationFooterLinkDeleted",
"spaceNavigationFooterLinkTranslationCreated",
"spaceNavigationFooterTranslationCreated",
"spaceNavigationHeaderCategoryCreated",
"spaceNavigationHeaderCategoryDeleted",
"spaceNavigationHeaderCategoryTranslationCreated",
"spaceNavigationHeaderCreated",
"spaceNavigationHeaderDeleted",
"spaceNavigationHeaderTranslationCreated",
"spaceNavigationModifiedAnchor",
"spaceNavigationModifiedFooterFooterText",
"spaceNavigationModifiedFooterLinkName",
"spaceNavigationModifiedFooterLinkOrder",
"spaceNavigationModifiedFooterName",
"spaceNavigationModifiedFooterOrder",
"spaceNavigationModifiedHeaderCategoryName",
"spaceNavigationModifiedHeaderCategoryOrder",
"spaceNavigationModifiedHeaderName",
"spaceNavigationModifiedHeaderOrder",
"spaceNavigationModifiedLink",
"spaceNavigationModifiedSpacePageID",
"spacePageCreated",
"spacePageDeleted",
"spacePageModifiedContent",
"spacePageModifiedName",
"spacePageModifiedSlug",
"spacePageTemplateCreated",
"spacePageTemplateDeleted",
"spacePageTemplateUpdated",
"spacePageTranslationCreated",
"spaceTemplateCreated",
"spaceTemplateDeleted",
"spaceTemplateUpdated",
"standardMetadataCreated",
"standardMetadataDeleted",
"standardMetadataModifiedValue",
"standardMetadataModifiedValueType",
"synonymColumnsModifiedSynonym1",
"synonymColumnsModifiedSynonym10",
"synonymColumnsModifiedSynonym11",
"synonymColumnsModifiedSynonym12",
"synonymColumnsModifiedSynonym13",
"synonymColumnsModifiedSynonym14",
"synonymColumnsModifiedSynonym15",
"synonymColumnsModifiedSynonym16",
"synonymColumnsModifiedSynonym17",
"synonymColumnsModifiedSynonym18",
"synonymColumnsModifiedSynonym19",
"synonymColumnsModifiedSynonym2",
"synonymColumnsModifiedSynonym20",
"synonymColumnsModifiedSynonym3",
"synonymColumnsModifiedSynonym4",
"synonymColumnsModifiedSynonym5",
"synonymColumnsModifiedSynonym6",
"synonymColumnsModifiedSynonym7",
"synonymColumnsModifiedSynonym8",
"synonymColumnsModifiedSynonym9",
"synonymCreated",
"synonymDeleted",
"synonymModifiedSynonym",
"tenantModifiedAdditionalDiskSpaceGigaByte",
"tenantModifiedCustomUnlockedFeatures",
"tenantModifiedCustomUnlockedFeaturesAdded",
"tenantModifiedCustomUnlockedFeaturesRemoved",
"tenantModifiedExpirationDate",
"tenantModifiedMediaPortalLimit",
"tenantModifiedPackageIdentifier",
"tenantModifiedReadOnlyUserLimit",
"tenantModifiedUserLimit",
"trashCreated",
"trashDeleted",
"trashFileIDsRestored",
"uploadLinkCreated",
"uploadLinkDeleted",
"uploadLinkFileUploaded",
"uploadLinkModifiedDescription",
"uploadLinkModifiedDirectoryID",
"uploadLinkModifiedEmailsAdded",
"uploadLinkModifiedFaceRecognitionDisabled",
"uploadLinkModifiedFileStateID",
"uploadLinkModifiedFilesAdded",
"uploadLinkModifiedFilesRemoved",
"uploadLinkModifiedIsDisabled",
"uploadLinkModifiedKeywordsAdded",
"uploadLinkModifiedKeywordsRemoved",
"uploadLinkModifiedLicenseReleaseIDsAdded",
"uploadLinkModifiedLicenseReleaseIDsRemoved",
"uploadLinkModifiedModelReleaseIDsAdded",
"uploadLinkModifiedModelReleaseIDsRemoved",
"uploadLinkModifiedName",
"uploadLinkModifiedNotificationText",
"uploadLinkModifiedPropertyReleaseIDsAdded",
"uploadLinkModifiedPropertyReleaseIDsRemoved",
"uploadLinkModifiedShowAllLicenseReleases",
"uploadLinkModifiedShowAllModelReleases",
"uploadLinkModifiedShowAllPropertyReleases",
"uploadLinkModifiedUploadCondition",
"uploadLinkModifiedUserID",
"uploadLinkModifiedValidityPeriod",
"userCreated",
"userDeleted",
"userModifiedCIFSPassword",
"userModifiedEmail",
"userModifiedFirstName",
"userModifiedIsActive",
"userModifiedIsExternal",
"userModifiedLanguage",
"userModifiedLastName",
"userModifiedLinked",
"userModifiedPassword",
"userModifiedPermissionGroupIDsAdded",
"userModifiedPermissionGroupIDsRemoved",
"userModifiedRefreshToken",
"userModifiedResetPasswordStamp",
"userModifiedResetPasswordToken",
"userModifiedSecret",
"userModifiedSecretExpirationDate",
"userModifiedTwoFactorAuthSetUp",
"userModifiedUnlinked",
"userModifiedUserName",
"userTrackingCreated",
"userTrackingDeleted",
"userTrackingModifiedFirstMonthlyLogin",
"userTrackingModifiedUserID",
"variantStackCreated",
"variantStackDeleted",
"variantStackModifiedDescription",
"variantStackModifiedFilesAdded",
"variantStackModifiedFilesRemoved",
"variantStackModifiedName",
"webhookCreated",
"webhookDeleted",
"webhookModifiedDescription",
"webhookModifiedEventKey",
"webhookModifiedEventKeysAdded",
"webhookModifiedEventKeysRemoved",
"webhookModifiedName",
"webhookModifiedSecret",
"webhookModifiedURL"
],
"example": "fileCreated",
"title": "EventKey",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"resourceID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"resourceName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"resourceOwnerUserID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"resourceOwnerUserName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"resourceOwnerUserType": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
},
"resourceType": {
"description": "The type of the resource that was affected by the event",
"enum": [
"apiKey",
"assetNavigator",
"assetNavigatorCategory",
"azureActiveDirectory",
"collection",
"comment",
"customMetadata",
"customMetadataLanguages",
"customMetadataOptionLanguages",
"customMetadataOptions",
"directLink",
"directory",
"download",
"downloadFormat",
"duplicateFile",
"emailCustomTemplate",
"externalShare",
"externalSharedCollection",
"externalSharesComment",
"externalSharesUpvote",
"file",
"fileState",
"filesCustomField",
"filter",
"generalSettings",
"identityProvider",
"importantMetadata",
"internalMetadata",
"keyword",
"license",
"licenseFile",
"login",
"manageAdministrationServer",
"manageBatchTenant",
"manageFeature",
"manageHost",
"managePackage",
"managePackagePortal",
"managePlugin",
"manageServer",
"manageSystem",
"manageUnlockedPlugin",
"messageCenter",
"metadataField",
"model",
"modelFile",
"newFile",
"permissionGroup",
"portal",
"portalAssetNavigator",
"portalCollection",
"property",
"propertyFile",
"report",
"settings",
"space",
"spaceNavigation",
"spacePage",
"spacePageTemplate",
"spaceTemplate",
"standardMetadata",
"synonym",
"synonymColumns",
"tenant",
"trash",
"uploadLink",
"user",
"userTracking",
"variantStack",
"webhook"
],
"example": "file",
"title": "EventResourceType",
"type": "string"
},
"userDescriptiveName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"userID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"userName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"userType": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
}
},
"title": "Event",
"type": "object"
},
"EventData": {
"description": "Additional data given as JSON Object. The structure of the Object varies with each different event key.",
"example": {
"eventKey": "collectionModifiedFilesAdded",
"filesAdded": [
{
"id": 42,
"name": "document.pdf"
},
{
"id": 73,
"name": "image.jpg"
},
{
"id": 156,
"name": "presentation.pptx"
}
]
},
"oneOf": [
{
"title": "APIKeyCreated",
"type": "object"
},
{
"title": "APIKeyDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIPRangeAdded"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIPRangeRemoved"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIsActive"
},
{
"$ref": "#/components/schemas/APIKeyModifiedName"
},
{
"$ref": "#/components/schemas/APIKeyModifiedScopeID"
},
{
"$ref": "#/components/schemas/APIKeyModifiedUserID"
},
{
"title": "AssetNavigatorCategoryCreated",
"type": "object"
},
{
"title": "AssetNavigatorCategoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryModifiedMetadataFieldID"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryModifiedOrder"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryTranslationModifiedName"
},
{
"title": "AssetNavigatorCreated",
"type": "object"
},
{
"title": "AssetNavigatorDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedCategory"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedDescription"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedName"
},
{
"title": "AzureActiveDirectoryCreated",
"type": "object"
},
{
"title": "AzureActiveDirectoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedClientID"
},
{
"title": "AzureActiveDirectoryModifiedClientSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedDeleteMode"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsActivated"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsAdded"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsDeactivated"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsRemoved"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedIPRangeAdded"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedIPRangeRemoved"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedName"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedNewUserDataOwner"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedRecursive"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedSyncTime"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedTenantID"
},
{
"title": "CollectionCreated",
"type": "object"
},
{
"title": "CollectionDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CollectionModifiedAssetNavigatorID"
},
{
"$ref": "#/components/schemas/CollectionModifiedDescription"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesCommented"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/CollectionModifiedLanguage"
},
{
"$ref": "#/components/schemas/CollectionModifiedName"
},
{
"$ref": "#/components/schemas/CollectionModifiedPreviewFileIDs"
},
{
"$ref": "#/components/schemas/CollectionModifiedUserID"
},
{
"$ref": "#/components/schemas/CollectionSharedExternally"
},
{
"$ref": "#/components/schemas/CollectionSharedInternally"
},
{
"$ref": "#/components/schemas/CollectionTranslationModifiedDescription"
},
{
"$ref": "#/components/schemas/CollectionTranslationModifiedName"
},
{
"$ref": "#/components/schemas/CollectionUnsharedInternally"
},
{
"$ref": "#/components/schemas/CommentCreated"
},
{
"$ref": "#/components/schemas/CommentDeleted"
},
{
"title": "CustomMetadataCreated",
"type": "object"
},
{
"title": "CustomMetadataDeleted",
"type": "object"
},
{
"title": "CustomMetadataLanguagesCreated",
"type": "object"
},
{
"title": "CustomMetadataLanguagesDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataLanguagesModifiedName"
},
{
"title": "CustomMetadataOptionsCreated",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsDeleted"
},
{
"title": "CustomMetadataOptionsLanguageCreated",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsLanguageDeleted"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsLanguageModifiedName"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsModifiedOrder"
},
{
"title": "CustomMetadataParentConditionCreated",
"type": "object"
},
{
"title": "CustomMetadataParentConditionDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataParentConditionModifiedCustomMetadataID"
},
{
"$ref": "#/components/schemas/CustomMetadataParentConditionModifiedCustomMetadataOptionIDs"
},
{
"$ref": "#/components/schemas/DataModelReleaseTranslationsModifiedLanguage"
},
{
"$ref": "#/components/schemas/DataModelReleaseTranslationsModifiedName"
},
{
"title": "DirectLinkCreated",
"type": "object"
},
{
"title": "DirectLinkDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedDownloadFormatID"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileID"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileName"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileSize"
},
{
"title": "DirectoryCreated",
"type": "object"
},
{
"title": "DirectoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DirectoryModifiedName"
},
{
"$ref": "#/components/schemas/DirectoryModifiedParentDirectoryID"
},
{
"title": "DownloadCreated",
"type": "object"
},
{
"title": "DownloadDeleted",
"type": "object"
},
{
"title": "DownloadFormatCreated",
"type": "object"
},
{
"title": "DownloadFormatDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedColorspace"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedDensity"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedFormatConversion"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedHeight"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedName"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedQuality"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedResize"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedResizeUnit"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedWidth"
},
{
"$ref": "#/components/schemas/DownloadFormatTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/DownloadFormatTranslationModifiedName"
},
{
"$ref": "#/components/schemas/DownloadModifiedDownloadFormatID"
},
{
"$ref": "#/components/schemas/DownloadModifiedFileIDsAdded"
},
{
"$ref": "#/components/schemas/DownloadModifiedFileIDsRemoved"
},
{
"$ref": "#/components/schemas/DownloadModifiedUserID"
},
{
"$ref": "#/components/schemas/DownloadModifiedUserName"
},
{
"title": "DuplicateFileCreated",
"type": "object"
},
{
"title": "DuplicateFileDeleted",
"type": "object"
},
{
"title": "EmailCustomTemplateCreated",
"type": "object"
},
{
"title": "EmailCustomTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedBody"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedLanguage"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedName"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedSubject"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedType"
},
{
"$ref": "#/components/schemas/ExternalShareCommentCreated"
},
{
"$ref": "#/components/schemas/ExternalShareCommentDeleted"
},
{
"title": "ExternalShareCreated",
"type": "object"
},
{
"title": "ExternalShareDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowComments"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowDownloads"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowUpvotes"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDescription"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedEmailsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFileDetailsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFileDetailsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatFree"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatOriginal"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatPreview"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedIsDisabled"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedMediaViewsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedMediaViewsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedName"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedNotificationText"
},
{
"title": "ExternalShareModifiedPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedTermsOfUse"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedUserID"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedValidityPeriod"
},
{
"$ref": "#/components/schemas/ExternalShareUpvoteCreated"
},
{
"$ref": "#/components/schemas/ExternalShareUpvoteDeleted"
},
{
"title": "ExternalShareViewed",
"type": "object"
},
{
"$ref": "#/components/schemas/FileCreated"
},
{
"title": "FileCustomFieldCreated",
"type": "object"
},
{
"title": "FileCustomFieldDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValue"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValueCustomFieldsOptionID"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValueCustomFieldsOptionIDs"
},
{
"$ref": "#/components/schemas/FileDeleted"
},
{
"$ref": "#/components/schemas/FileDeletedDuplicate"
},
{
"$ref": "#/components/schemas/FileDownloaded"
},
{
"$ref": "#/components/schemas/FileModifiedCollectionIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedCollectionIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedCreateDate"
},
{
"$ref": "#/components/schemas/FileModifiedCreator"
},
{
"$ref": "#/components/schemas/FileModifiedDescription"
},
{
"$ref": "#/components/schemas/FileModifiedDirectoryIDPath"
},
{
"$ref": "#/components/schemas/FileModifiedExternalShareIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedExternalShareIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedFileName"
},
{
"$ref": "#/components/schemas/FileModifiedFileStateID"
},
{
"$ref": "#/components/schemas/FileModifiedIsCheckedOut"
},
{
"$ref": "#/components/schemas/FileModifiedIsDownloadLocked"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsRecognitionAdded"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsRecognitionDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedLanguageCodesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedLanguageCodesRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedLicenseFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedLicenseFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedLocation"
},
{
"$ref": "#/components/schemas/FileModifiedMainVersionFileID"
},
{
"$ref": "#/components/schemas/FileModifiedMarkedUserIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMarkedUserIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldDate"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldFocalPoint"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLanguagesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLanguagesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLocation"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldMultiSelectionsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldMultiSelectionsDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldOrientation"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldSelection"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldText"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldTruncate"
},
{
"$ref": "#/components/schemas/FileModifiedModelFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedModelFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedPropertyFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedPropertyFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedRating"
},
{
"$ref": "#/components/schemas/FileModifiedRotation"
},
{
"$ref": "#/components/schemas/FileModifiedSubject"
},
{
"$ref": "#/components/schemas/FileModifiedUploadDate"
},
{
"$ref": "#/components/schemas/FileModifiedUploadLink"
},
{
"$ref": "#/components/schemas/FileModifiedUserID"
},
{
"$ref": "#/components/schemas/FileModifiedVariantStack"
},
{
"$ref": "#/components/schemas/FileReplaced"
},
{
"$ref": "#/components/schemas/FileReplacedPreviewFile"
},
{
"title": "FileRestoredPreviewFile",
"type": "object"
},
{
"title": "FileStateCreated",
"type": "object"
},
{
"title": "FileStateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FileStateModifiedColor"
},
{
"$ref": "#/components/schemas/FileStateModifiedDescription"
},
{
"$ref": "#/components/schemas/FileStateModifiedForceComment"
},
{
"$ref": "#/components/schemas/FileStateModifiedIsArchive"
},
{
"$ref": "#/components/schemas/FileStateModifiedName"
},
{
"$ref": "#/components/schemas/FileStateModifiedOrder"
},
{
"title": "FilterCreated",
"type": "object"
},
{
"title": "FilterDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FilterModified"
},
{
"$ref": "#/components/schemas/FilterModifiedName"
},
{
"$ref": "#/components/schemas/FilterModifiedUserID"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedAllowConcurrentLogin"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedAllowDuplicates"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedCheckSessionFiles"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDailyAPILimit"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDataPrivacyText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDataPrivacyURL"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDefaultLanguageCodesAdded"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDefaultLanguageCodesRemoved"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDirectoriesInMediaview"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheSize"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheStoreCroppedFiles"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheTime"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadLockedText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedEnableForgotPasswordOption"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedExternalShareAlias"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedFaceRecognition"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedGeneralUploadText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedKeywordUploadText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedKeywordsBoundToPermissionGroups"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedLegalNoticeText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedLegalNoticeURL"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedMetadataFieldsOrder"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedPasswordSecurityLevel"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSecondAPILimit"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSemanticSearch"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSessionTimeout"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowChat"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowFileOwner"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowUnimportantMetadataFields"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSmartTagging"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSubjectExtractionType"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSystemLanguage"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTextRecognition"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTranslationLanguagesAdded"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTranslationLanguagesRemoved"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTwoFactorAuth"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedUseAlreadyIncludedKeywords"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoForceConversion"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoMaxDuration"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoMaxSize"
},
{
"title": "IdentityProviderCreated",
"type": "object"
},
{
"title": "IdentityProviderDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedAuthorizationEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedClientID"
},
{
"title": "IdentityProviderModifiedClientSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedIsActive"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedMetadataEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedName"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedTokenEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedUserEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedUserField"
},
{
"title": "ImportantMetadataCreated",
"type": "object"
},
{
"title": "ImportantMetadataDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedIsEditable"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedIsIndexed"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedOrder"
},
{
"title": "KeywordCreated",
"type": "object"
},
{
"title": "KeywordDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/KeywordModifiedPermissionGroupIDsAdded"
},
{
"$ref": "#/components/schemas/KeywordModifiedPermissionGroupIDsRemoved"
},
{
"title": "LicenseCreated",
"type": "object"
},
{
"title": "LicenseDeleted",
"type": "object"
},
{
"title": "LicenseFileCreated",
"type": "object"
},
{
"title": "LicenseFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedColor"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedCreateDate"
},
{
"title": "LicenseFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedInfosAdded"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedInfosRemoved"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/LicenseModifiedProvider"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedContentName"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedContentValue"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/LicenseReleaseTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/LicenseReleaseTranslationModifiedName"
},
{
"$ref": "#/components/schemas/LoginAttempted"
},
{
"title": "ManageAdministrationServerCreated",
"type": "object"
},
{
"title": "ManageAdministrationServerDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManageAdministrationServerModifiedAdministrationServerIdentifier"
},
{
"$ref": "#/components/schemas/ManageAdministrationServerModifiedAllowsPushConnection"
},
{
"$ref": "#/components/schemas/ManageAdministrationServerModifiedName"
},
{
"$ref": "#/components/schemas/ManageAdministrationServerModifiedURL"
},
{
"title": "ManageApplicationKeyCreated",
"type": "object"
},
{
"title": "ManageApplicationKeyDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManageApplicationKeyModifiedCustomerIdentifier"
},
{
"$ref": "#/components/schemas/ManageApplicationKeyModifiedIsActive"
},
{
"$ref": "#/components/schemas/ManageApplicationKeyModifiedKey"
},
{
"$ref": "#/components/schemas/ManageApplicationKeyModifiedName"
},
{
"$ref": "#/components/schemas/ManageApplicationKeyModifiedUnlockedUniversal"
},
{
"$ref": "#/components/schemas/ManageBatchTenant"
},
{
"title": "ManageHostCreated",
"type": "object"
},
{
"title": "ManageHostDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManageHostModifiedHostName"
},
{
"$ref": "#/components/schemas/ManageHostModifiedHostType"
},
{
"$ref": "#/components/schemas/ManageHostModifiedSystemIdentifier"
},
{
"title": "ManagePackageCreated",
"type": "object"
},
{
"title": "ManagePackageDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedAvailablePluginsAdded"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedAvailablePluginsRemoved"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedBookingEnabled"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedCustomerValue"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedDailyAPILimit"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedDiskSpacePerUser"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedFeatures"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedHideAllPackages"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedHideCustomerGroupPackages"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedHideUniversalPackages"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedIncludedDiskspace"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedName"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedPluginLimit"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedSecondAPILimit"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedUnlockedCustomerGroupsAdded"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedUnlockedCustomerGroupsRemoved"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedUnlockedSystemIdentifiersAdded"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedUnlockedSystemIdentifiersRemoved"
},
{
"$ref": "#/components/schemas/ManagePackageModifiedUnlockedUniversal"
},
{
"title": "ManagePortalPackageCreated",
"type": "object"
},
{
"title": "ManagePortalPackageDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManagePortalPackageModifiedFeatures"
},
{
"$ref": "#/components/schemas/ManagePortalPackageModifiedName"
},
{
"$ref": "#/components/schemas/ManageServerRecreateConfig"
},
{
"$ref": "#/components/schemas/ManageServerReload"
},
{
"$ref": "#/components/schemas/ManageSystemCreated"
},
{
"$ref": "#/components/schemas/ManageSystemDeleted"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedAdditionalDiskSpaceGigaByte"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedAdministrationServerIdentifier"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedCustomerGroupsAdded"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedCustomerGroupsRemoved"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedCustomerIdentifier"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedDataPath"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedDatabaseAlias"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedDomainName"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedExpirationDate"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedHostName"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedInstallationType"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedIsCurrentlyUpdating"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedIsPaused"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedLastSentMail"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedMediaPortalLimit"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedName"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedOperatingSystem"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedPixxioVersion"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedReadOnlyUserLimit"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedReceiveBetaUpdates"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedReceiveUpdates"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSQLDatabase"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSQLHost"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSQLPassword"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSQLUserName"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSolrBaseCore"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSolrOrigin"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSolrPassword"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedSolrUserName"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedUDID"
},
{
"$ref": "#/components/schemas/ManageSystemModifiedUserLimit"
},
{
"title": "ManageUnlockedApplicationKeyCreated",
"type": "object"
},
{
"title": "ManageUnlockedApplicationKeyDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ManageUnlockedApplicationKeyModifiedRedirectURI"
},
{
"$ref": "#/components/schemas/ManageUnlockedApplicationKeyModifiedSystemIdentifier"
},
{
"title": "MessageCenterCreated",
"type": "object"
},
{
"title": "MessageCenterDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedCollectionsAdded"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedCollectionsRemoved"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationByApplication"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationByEmail"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationDayTime"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationInterval"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationMonthDay"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationWeekDay"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionDeleted"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionEdited"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionMessagingWithoutSubscription"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionShared"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionSharedInternalWithMe"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyExternalSharedCollectionOpened"
},
{
"title": "MetadataFieldCreated",
"type": "object"
},
{
"title": "MetadataFieldDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedEditType"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIndexedForSearchTerm"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIsImportant"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIsSearchable"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedName"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsAdded"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsRemoved"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsRenamed"
},
{
"title": "ModelCreated",
"type": "object"
},
{
"title": "ModelDeleted",
"type": "object"
},
{
"title": "ModelFileCreated",
"type": "object"
},
{
"title": "ModelFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ModelFileModifiedColor"
},
{
"$ref": "#/components/schemas/ModelFileModifiedCreateDate"
},
{
"title": "ModelFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/ModelFileModifiedName"
},
{
"$ref": "#/components/schemas/ModelFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/ModelFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/ModelFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/ModelModifiedBirthDate"
},
{
"$ref": "#/components/schemas/ModelModifiedEmail"
},
{
"$ref": "#/components/schemas/ModelModifiedFirstName"
},
{
"$ref": "#/components/schemas/ModelModifiedLastName"
},
{
"title": "NewFileCreated",
"type": "object"
},
{
"title": "PermissionGroupCreated",
"type": "object"
},
{
"title": "PermissionGroupDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCommentFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateKeywords"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreatePortals"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateUploadLinks"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDefaultUploadFileState"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteForeignCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteForeignFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteOwnCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteOwnFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDownloadFormatIDsAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDownloadFormatIDsRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditDesign"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditFilesInHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditFilesInInternalSharedCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditForeignCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditForeignFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditLicenses"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditUsers"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceExportProof"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatFree"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatOriginal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatPreview"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedIsAdmin"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedIsExternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedLinked"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedModifyDirectoriesInHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedName"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsExternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsInternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsNetwork"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareFilesNetwork"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShowAllCustomDownloadFormats"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUnlinked"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadFilesToHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadObligationsAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadObligationsRemoved"
},
{
"$ref": "#/components/schemas/PortalCollectionModifiedIsProtected"
},
{
"$ref": "#/components/schemas/PortalCollectionModifiedOrder"
},
{
"title": "PortalCreated",
"type": "object"
},
{
"title": "PortalDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedActivateUserAutomatically"
},
{
"$ref": "#/components/schemas/PortalModifiedAddShadowToFont"
},
{
"$ref": "#/components/schemas/PortalModifiedAutomaticallyActivatedDomainsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedAutomaticallyActivatedDomainsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedBackgroundColor"
},
{
"$ref": "#/components/schemas/PortalModifiedBrandURL"
},
{
"title": "PortalModifiedBrandingLogoImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionAssetNavigator"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedCookieLinkPrivacyPage"
},
{
"$ref": "#/components/schemas/PortalModifiedCookiePlacement"
},
{
"$ref": "#/components/schemas/PortalModifiedCustomMetadataIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedCustomMetadataIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedDefaultMetadataFieldsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedDefaultMetadataFieldsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedEmailReceiver"
},
{
"$ref": "#/components/schemas/PortalModifiedFilterOptionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedFilterOptionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/PortalModifiedForceWatermark"
},
{
"title": "PortalModifiedGeneralPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHasUserRegistration"
},
{
"$ref": "#/components/schemas/PortalModifiedHasWhitelabel"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroArrowColor"
},
{
"title": "PortalModifiedHeroBannerImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroFontColor"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroLogoColor"
},
{
"title": "PortalModifiedHeroLogoImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHostNames"
},
{
"$ref": "#/components/schemas/PortalModifiedIsActive"
},
{
"$ref": "#/components/schemas/PortalModifiedLandingPageOptions"
},
{
"$ref": "#/components/schemas/PortalModifiedLanguagesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedLanguagesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedLicenseReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedLicenseReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedMainHostName"
},
{
"$ref": "#/components/schemas/PortalModifiedMediaViewsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedMediaViewsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedModelReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedModelReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedName"
},
{
"$ref": "#/components/schemas/PortalModifiedOriginalDownloadFormatTypesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedOriginalDownloadFormatTypesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPageName"
},
{
"$ref": "#/components/schemas/PortalModifiedPageText"
},
{
"$ref": "#/components/schemas/PortalModifiedPagesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPagesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPlacementsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPlacementsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPreferredMode"
},
{
"$ref": "#/components/schemas/PortalModifiedPreferredTitle"
},
{
"$ref": "#/components/schemas/PortalModifiedPropertyReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPropertyReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedRestrictAccess"
},
{
"$ref": "#/components/schemas/PortalModifiedSearchFieldsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedSearchFieldsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowBorder"
},
{
"$ref": "#/components/schemas/PortalModifiedShowCookieInformation"
},
{
"$ref": "#/components/schemas/PortalModifiedShowCreateLinkToFileTab"
},
{
"$ref": "#/components/schemas/PortalModifiedShowFileType"
},
{
"$ref": "#/components/schemas/PortalModifiedShowLicenseReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowModelReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowPropertyReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowStartScreen"
},
{
"$ref": "#/components/schemas/PortalModifiedSortOptionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedSortOptionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedStandardMetadataIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedStandardMetadataIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedUseSSO"
},
{
"$ref": "#/components/schemas/PortalModifiedUseSemanticSearch"
},
{
"$ref": "#/components/schemas/PortalModifiedUserCompany"
},
{
"$ref": "#/components/schemas/PortalModifiedUserDepartment"
},
{
"$ref": "#/components/schemas/PortalModifiedUserEmail"
},
{
"$ref": "#/components/schemas/PortalModifiedUserFirstName"
},
{
"$ref": "#/components/schemas/PortalModifiedUserIsActive"
},
{
"$ref": "#/components/schemas/PortalModifiedUserIsConfirmed"
},
{
"$ref": "#/components/schemas/PortalModifiedUserLanguage"
},
{
"$ref": "#/components/schemas/PortalModifiedUserLastName"
},
{
"$ref": "#/components/schemas/PortalModifiedUserPassword"
},
{
"$ref": "#/components/schemas/PortalModifiedUsersAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedUsersRemoved"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedName"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedText"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedCookieTextShort"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedFooterText"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedHeroSlogan"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedStartScreenText"
},
{
"title": "PropertyCreated",
"type": "object"
},
{
"title": "PropertyDeleted",
"type": "object"
},
{
"title": "PropertyFileCreated",
"type": "object"
},
{
"title": "PropertyFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedColor"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedCreateDate"
},
{
"title": "PropertyFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedName"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/PropertyModifiedAddress"
},
{
"$ref": "#/components/schemas/PropertyModifiedName"
},
{
"$ref": "#/components/schemas/PropertyModifiedOwner"
},
{
"$ref": "#/components/schemas/PropertyReleaseTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PropertyReleaseTranslationModifiedName"
},
{
"title": "ReportCreated",
"type": "object"
},
{
"title": "ReportDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ReportModifiedAdditionalText"
},
{
"$ref": "#/components/schemas/ReportModifiedDayInMonth"
},
{
"$ref": "#/components/schemas/ReportModifiedDayInWeek"
},
{
"$ref": "#/components/schemas/ReportModifiedDayTime"
},
{
"$ref": "#/components/schemas/ReportModifiedIsActive"
},
{
"$ref": "#/components/schemas/ReportModifiedName"
},
{
"$ref": "#/components/schemas/ReportModifiedReceiverEmailsAdded"
},
{
"$ref": "#/components/schemas/ReportModifiedReceiverEmailsRemoved"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsAdded"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsRemoved"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsReplaced"
},
{
"$ref": "#/components/schemas/ReportModifiedReportInterval"
},
{
"$ref": "#/components/schemas/ReportModifiedReportWhenNoData"
},
{
"$ref": "#/components/schemas/ReportModifiedSendCSV"
},
{
"$ref": "#/components/schemas/ReportModifiedSendPDF"
},
{
"$ref": "#/components/schemas/SettingsModifiedCustomJavaScript"
},
{
"$ref": "#/components/schemas/SettingsModifiedDateFormat"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCollectionSyncHostName"
},
{
"title": "SettingsModifiedExternalCollectionSyncPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCollectionSyncUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCustomCss"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalShareHostName"
},
{
"title": "SettingsModifiedExternalSharePassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalShareUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedFaviconFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedFaviconText"
},
{
"$ref": "#/components/schemas/SettingsModifiedFont"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBigDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBigLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBootFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoDarkFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoIconDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoIconLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoLink"
},
{
"$ref": "#/components/schemas/SettingsModifiedPrimaryColorDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedPrimaryColorLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedProxyHostName"
},
{
"$ref": "#/components/schemas/SettingsModifiedProxyPort"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPHasSSL"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPHostName"
},
{
"title": "SettingsModifiedSMTPPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPPort"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPTransmitterEmail"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPTransmitterName"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPUseDefault"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedSecondaryColorDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedSecondaryColorLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedSloganStartscreen"
},
{
"$ref": "#/components/schemas/SettingsModifiedStartscreenFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedUploadLinkBackgroundFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomMiddle"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsCenter"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsMiddleLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsMiddleRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperMiddle"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositioningType"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkText"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkTransparency"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkWidthPercent"
},
{
"title": "SpaceCreated",
"type": "object"
},
{
"title": "SpaceDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceModifiedAutomaticallyActivatedDomainsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedAutomaticallyActivatedDomainsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedCopyrightText"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomBodyFontFileID"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomHeadingsFontFileID"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomMetadataIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomization"
},
{
"$ref": "#/components/schemas/SpaceModifiedDefaultMetadataFields"
},
{
"$ref": "#/components/schemas/SpaceModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedFaviconImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/SpaceModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/SpaceModifiedHostNames"
},
{
"$ref": "#/components/schemas/SpaceModifiedIsActive"
},
{
"$ref": "#/components/schemas/SpaceModifiedLanguagesAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedLanguagesRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedLicenseReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginBackgroundImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginHeadline"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginRequired"
},
{
"$ref": "#/components/schemas/SpaceModifiedLogoDarkImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedLogoLightImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedMainHostName"
},
{
"$ref": "#/components/schemas/SpaceModifiedModelReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedName"
},
{
"$ref": "#/components/schemas/SpaceModifiedOriginalDownloadFormatTypesAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedOriginalDownloadFormatTypesRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedPermissionGroupsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedPermissionGroupsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedPreferredTitle"
},
{
"$ref": "#/components/schemas/SpaceModifiedPrimaryColor"
},
{
"$ref": "#/components/schemas/SpaceModifiedPropertyReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedSearchFieldsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedSearchFieldsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedSecondaryColor"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowFileType"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowLicenseReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowModelReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowPropertyReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowTermsOfUse"
},
{
"$ref": "#/components/schemas/SpaceModifiedStandardMetadataIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedStartScreenPage"
},
{
"$ref": "#/components/schemas/SpaceModifiedTermsOfUse"
},
{
"$ref": "#/components/schemas/SpaceModifiedUseSSO"
},
{
"$ref": "#/components/schemas/SpaceModifiedUseSemanticSearch"
},
{
"title": "SpaceNavigationFooterCreated",
"type": "object"
},
{
"title": "SpaceNavigationFooterDeleted",
"type": "object"
},
{
"title": "SpaceNavigationHeaderCreated",
"type": "object"
},
{
"title": "SpaceNavigationHeaderDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedAnchor"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterFooterText"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterName"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterOrder"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedHeaderName"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedHeaderOrder"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedLink"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedSpacePageID"
},
{
"title": "SpacePageCreated",
"type": "object"
},
{
"title": "SpacePageDeleted",
"type": "object"
},
{
"title": "SpacePageModifiedContent",
"type": "object"
},
{
"$ref": "#/components/schemas/SpacePageModifiedName"
},
{
"$ref": "#/components/schemas/SpacePageModifiedSlug"
},
{
"title": "SpacePageTemplateCreated",
"type": "object"
},
{
"title": "SpacePageTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpacePageTemplateUpdated"
},
{
"title": "SpaceTemplateCreated",
"type": "object"
},
{
"title": "SpaceTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceTemplateUpdated"
},
{
"title": "StandardMetadataCreated",
"type": "object"
},
{
"title": "StandardMetadataDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/StandardMetadataModifiedValue"
},
{
"$ref": "#/components/schemas/StandardMetadataModifiedValueType"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym1"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym10"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym11"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym12"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym13"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym14"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym15"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym16"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym17"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym18"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym19"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym2"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym20"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym3"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym4"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym5"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym6"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym7"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym8"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym9"
},
{
"title": "SynonymCreated",
"type": "object"
},
{
"title": "SynonymDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SynonymModifiedSynonym"
},
{
"$ref": "#/components/schemas/TenantModifiedAdditionalDiskSpaceGigaByte"
},
{
"$ref": "#/components/schemas/TenantModifiedExpirationDate"
},
{
"$ref": "#/components/schemas/TenantModifiedIsPaused"
},
{
"$ref": "#/components/schemas/TenantModifiedMediaPortalLimit"
},
{
"$ref": "#/components/schemas/TenantModifiedReadOnlyUserLimit"
},
{
"$ref": "#/components/schemas/TenantModifiedUserLimit"
},
{
"$ref": "#/components/schemas/TrashCreated"
},
{
"title": "TrashDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/TrashRestored"
},
{
"title": "UploadLinkCreated",
"type": "object"
},
{
"title": "UploadLinkDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/UploadLinkFileUploaded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedDescription"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedDirectoryID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedEmailsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFaceRecognitionDisabled"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFileStateID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedIsDisabled"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedKeywordsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedKeywordsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedLicenseReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedLicenseReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedModelReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedModelReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedName"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedNotificationText"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedPropertyReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedPropertyReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedUploadCondition"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedUserID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedValidityPeriod"
},
{
"title": "UserCreated",
"type": "object"
},
{
"title": "UserDeleted",
"type": "object"
},
{
"title": "UserModifiedCIFSPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedEmail"
},
{
"$ref": "#/components/schemas/UserModifiedFirstName"
},
{
"$ref": "#/components/schemas/UserModifiedIsActive"
},
{
"$ref": "#/components/schemas/UserModifiedIsExternal"
},
{
"$ref": "#/components/schemas/UserModifiedLanguage"
},
{
"$ref": "#/components/schemas/UserModifiedLastName"
},
{
"$ref": "#/components/schemas/UserModifiedLinked"
},
{
"title": "UserModifiedPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedPermissionGroupIDsAdded"
},
{
"$ref": "#/components/schemas/UserModifiedPermissionGroupIDsRemoved"
},
{
"$ref": "#/components/schemas/UserModifiedRefreshToken"
},
{
"$ref": "#/components/schemas/UserModifiedResetPasswordStamp"
},
{
"$ref": "#/components/schemas/UserModifiedResetPasswordToken"
},
{
"title": "UserModifiedSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedSecretExpirationDate"
},
{
"$ref": "#/components/schemas/UserModifiedTwoFactorAuthSetUp"
},
{
"$ref": "#/components/schemas/UserModifiedUnlinked"
},
{
"$ref": "#/components/schemas/UserModifiedUserName"
},
{
"title": "UserTrackingCreated",
"type": "object"
},
{
"title": "UserTrackingDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/UserTrackingModifiedFirstMonthlyLogin"
},
{
"$ref": "#/components/schemas/UserTrackingModifiedUserID"
},
{
"title": "VariantStackCreated",
"type": "object"
},
{
"title": "VariantStackDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/VariantStackModifiedDescription"
},
{
"$ref": "#/components/schemas/VariantStackModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/VariantStackModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/VariantStackModifiedName"
},
{
"title": "WebhookCreated",
"type": "object"
},
{
"title": "WebhookDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/WebhookModifiedDescription"
},
{
"$ref": "#/components/schemas/WebhookModifiedEventKeysAdded"
},
{
"$ref": "#/components/schemas/WebhookModifiedEventKeysRemoved"
},
{
"$ref": "#/components/schemas/WebhookModifiedName"
},
{
"$ref": "#/components/schemas/WebhookModifiedURL"
},
{
"title": "WebhookModifiedWebhookSecret",
"type": "object"
}
],
"title": "EventData",
"type": "object"
},
"EventDataOnlyApplication": {
"description": "Additional data given as JSON Object. The structure of the Object varies with each different event key.",
"example": {
"eventKey": "collectionModifiedFilesAdded",
"filesAdded": [
{
"id": 42,
"name": "document.pdf"
},
{
"id": 73,
"name": "image.jpg"
},
{
"id": 156,
"name": "presentation.pptx"
}
]
},
"oneOf": [
{
"title": "APIKeyCreated",
"type": "object"
},
{
"title": "APIKeyDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIPRangeAdded"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIPRangeRemoved"
},
{
"$ref": "#/components/schemas/APIKeyModifiedIsActive"
},
{
"$ref": "#/components/schemas/APIKeyModifiedName"
},
{
"$ref": "#/components/schemas/APIKeyModifiedScopeID"
},
{
"$ref": "#/components/schemas/APIKeyModifiedUserID"
},
{
"title": "AssetNavigatorCategoryCreated",
"type": "object"
},
{
"title": "AssetNavigatorCategoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryModifiedMetadataFieldID"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryModifiedOrder"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/AssetNavigatorCategoryTranslationModifiedName"
},
{
"title": "AssetNavigatorCreated",
"type": "object"
},
{
"title": "AssetNavigatorDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedCategory"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedDescription"
},
{
"$ref": "#/components/schemas/AssetNavigatorModifiedName"
},
{
"title": "AzureActiveDirectoryCreated",
"type": "object"
},
{
"title": "AzureActiveDirectoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedClientID"
},
{
"title": "AzureActiveDirectoryModifiedClientSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedDeleteMode"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsActivated"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsAdded"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsDeactivated"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedGroupsRemoved"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedIPRangeAdded"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedIPRangeRemoved"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedName"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedNewUserDataOwner"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedRecursive"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedSyncTime"
},
{
"$ref": "#/components/schemas/AzureActiveDirectoryModifiedTenantID"
},
{
"title": "CollectionCreated",
"type": "object"
},
{
"title": "CollectionDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CollectionModifiedAssetNavigatorID"
},
{
"$ref": "#/components/schemas/CollectionModifiedDescription"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesCommented"
},
{
"$ref": "#/components/schemas/CollectionModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/CollectionModifiedLanguage"
},
{
"$ref": "#/components/schemas/CollectionModifiedName"
},
{
"$ref": "#/components/schemas/CollectionModifiedPreviewFileIDs"
},
{
"$ref": "#/components/schemas/CollectionModifiedUserID"
},
{
"$ref": "#/components/schemas/CollectionSharedExternally"
},
{
"$ref": "#/components/schemas/CollectionSharedInternally"
},
{
"$ref": "#/components/schemas/CollectionTranslationModifiedDescription"
},
{
"$ref": "#/components/schemas/CollectionTranslationModifiedName"
},
{
"$ref": "#/components/schemas/CollectionUnsharedInternally"
},
{
"$ref": "#/components/schemas/CommentCreated"
},
{
"$ref": "#/components/schemas/CommentDeleted"
},
{
"title": "CustomMetadataCreated",
"type": "object"
},
{
"title": "CustomMetadataDeleted",
"type": "object"
},
{
"title": "CustomMetadataLanguagesCreated",
"type": "object"
},
{
"title": "CustomMetadataLanguagesDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataLanguagesModifiedName"
},
{
"title": "CustomMetadataOptionsCreated",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsDeleted"
},
{
"title": "CustomMetadataOptionsLanguageCreated",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsLanguageDeleted"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsLanguageModifiedName"
},
{
"$ref": "#/components/schemas/CustomMetadataOptionsModifiedOrder"
},
{
"title": "CustomMetadataParentConditionCreated",
"type": "object"
},
{
"title": "CustomMetadataParentConditionDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/CustomMetadataParentConditionModifiedCustomMetadataID"
},
{
"$ref": "#/components/schemas/CustomMetadataParentConditionModifiedCustomMetadataOptionIDs"
},
{
"$ref": "#/components/schemas/DataModelReleaseTranslationsModifiedLanguage"
},
{
"$ref": "#/components/schemas/DataModelReleaseTranslationsModifiedName"
},
{
"title": "DirectLinkCreated",
"type": "object"
},
{
"title": "DirectLinkDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedDownloadFormatID"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileID"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileName"
},
{
"$ref": "#/components/schemas/DirectLinkModifiedFileSize"
},
{
"title": "DirectoryCreated",
"type": "object"
},
{
"title": "DirectoryDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DirectoryModifiedName"
},
{
"$ref": "#/components/schemas/DirectoryModifiedParentDirectoryID"
},
{
"title": "DownloadCreated",
"type": "object"
},
{
"title": "DownloadDeleted",
"type": "object"
},
{
"title": "DownloadFormatCreated",
"type": "object"
},
{
"title": "DownloadFormatDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedColorspace"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedDensity"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedFormatConversion"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedHeight"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedName"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedQuality"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedResize"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedResizeUnit"
},
{
"$ref": "#/components/schemas/DownloadFormatModifiedWidth"
},
{
"$ref": "#/components/schemas/DownloadFormatTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/DownloadFormatTranslationModifiedName"
},
{
"$ref": "#/components/schemas/DownloadModifiedDownloadFormatID"
},
{
"$ref": "#/components/schemas/DownloadModifiedFileIDsAdded"
},
{
"$ref": "#/components/schemas/DownloadModifiedFileIDsRemoved"
},
{
"$ref": "#/components/schemas/DownloadModifiedUserID"
},
{
"$ref": "#/components/schemas/DownloadModifiedUserName"
},
{
"title": "DuplicateFileCreated",
"type": "object"
},
{
"title": "DuplicateFileDeleted",
"type": "object"
},
{
"title": "EmailCustomTemplateCreated",
"type": "object"
},
{
"title": "EmailCustomTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedBody"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedLanguage"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedName"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedSubject"
},
{
"$ref": "#/components/schemas/EmailCustomTemplateModifiedType"
},
{
"$ref": "#/components/schemas/ExternalShareCommentCreated"
},
{
"$ref": "#/components/schemas/ExternalShareCommentDeleted"
},
{
"title": "ExternalShareCreated",
"type": "object"
},
{
"title": "ExternalShareDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowComments"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowDownloads"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedAllowUpvotes"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDescription"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedEmailsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFileDetailsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFileDetailsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatFree"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatOriginal"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedHasDownloadFormatPreview"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedIsDisabled"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedMediaViewsAdded"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedMediaViewsRemoved"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedName"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedNotificationText"
},
{
"title": "ExternalShareModifiedPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedTermsOfUse"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedUserID"
},
{
"$ref": "#/components/schemas/ExternalShareModifiedValidityPeriod"
},
{
"$ref": "#/components/schemas/ExternalShareUpvoteCreated"
},
{
"$ref": "#/components/schemas/ExternalShareUpvoteDeleted"
},
{
"title": "ExternalShareViewed",
"type": "object"
},
{
"$ref": "#/components/schemas/FileCreated"
},
{
"title": "FileCustomFieldCreated",
"type": "object"
},
{
"title": "FileCustomFieldDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValue"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValueCustomFieldsOptionID"
},
{
"$ref": "#/components/schemas/FileCustomFieldModifiedValueCustomFieldsOptionIDs"
},
{
"$ref": "#/components/schemas/FileDeleted"
},
{
"$ref": "#/components/schemas/FileDeletedDuplicate"
},
{
"$ref": "#/components/schemas/FileDownloaded"
},
{
"$ref": "#/components/schemas/FileModifiedCollectionIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedCollectionIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedCreateDate"
},
{
"$ref": "#/components/schemas/FileModifiedCreator"
},
{
"$ref": "#/components/schemas/FileModifiedDescription"
},
{
"$ref": "#/components/schemas/FileModifiedDirectoryIDPath"
},
{
"$ref": "#/components/schemas/FileModifiedExternalShareIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedExternalShareIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedFileName"
},
{
"$ref": "#/components/schemas/FileModifiedFileStateID"
},
{
"$ref": "#/components/schemas/FileModifiedIsCheckedOut"
},
{
"$ref": "#/components/schemas/FileModifiedIsDownloadLocked"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsRecognitionAdded"
},
{
"$ref": "#/components/schemas/FileModifiedKeywordsRecognitionDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedLanguageCodesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedLanguageCodesRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedLicenseFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedLicenseFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedLocation"
},
{
"$ref": "#/components/schemas/FileModifiedMainVersionFileID"
},
{
"$ref": "#/components/schemas/FileModifiedMarkedUserIDsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMarkedUserIDsRemoved"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldDate"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldFocalPoint"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLanguagesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLanguagesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldLocation"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldMultiSelectionsAdded"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldMultiSelectionsDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldOrientation"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldSelection"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldText"
},
{
"$ref": "#/components/schemas/FileModifiedMetadataFieldTruncate"
},
{
"$ref": "#/components/schemas/FileModifiedModelFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedModelFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedPropertyFilesAdded"
},
{
"$ref": "#/components/schemas/FileModifiedPropertyFilesDeleted"
},
{
"$ref": "#/components/schemas/FileModifiedRating"
},
{
"$ref": "#/components/schemas/FileModifiedRotation"
},
{
"$ref": "#/components/schemas/FileModifiedSubject"
},
{
"$ref": "#/components/schemas/FileModifiedUploadDate"
},
{
"$ref": "#/components/schemas/FileModifiedUploadLink"
},
{
"$ref": "#/components/schemas/FileModifiedUserID"
},
{
"$ref": "#/components/schemas/FileModifiedVariantStack"
},
{
"$ref": "#/components/schemas/FileReplaced"
},
{
"$ref": "#/components/schemas/FileReplacedPreviewFile"
},
{
"title": "FileRestoredPreviewFile",
"type": "object"
},
{
"title": "FileStateCreated",
"type": "object"
},
{
"title": "FileStateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FileStateModifiedColor"
},
{
"$ref": "#/components/schemas/FileStateModifiedDescription"
},
{
"$ref": "#/components/schemas/FileStateModifiedForceComment"
},
{
"$ref": "#/components/schemas/FileStateModifiedIsArchive"
},
{
"$ref": "#/components/schemas/FileStateModifiedName"
},
{
"$ref": "#/components/schemas/FileStateModifiedOrder"
},
{
"title": "FilterCreated",
"type": "object"
},
{
"title": "FilterDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/FilterModified"
},
{
"$ref": "#/components/schemas/FilterModifiedName"
},
{
"$ref": "#/components/schemas/FilterModifiedUserID"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedAllowConcurrentLogin"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedAllowDuplicates"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedCheckSessionFiles"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDailyAPILimit"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDataPrivacyText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDataPrivacyURL"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDefaultLanguageCodesAdded"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDefaultLanguageCodesRemoved"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDirectoriesInMediaview"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheSize"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheStoreCroppedFiles"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadCacheTime"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedDownloadLockedText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedEnableForgotPasswordOption"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedExternalShareAlias"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedFaceRecognition"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedGeneralUploadText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedKeywordUploadText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedKeywordsBoundToPermissionGroups"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedLegalNoticeText"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedLegalNoticeURL"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedMetadataFieldsOrder"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedPasswordSecurityLevel"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSecondAPILimit"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSemanticSearch"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSessionTimeout"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowChat"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowFileOwner"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedShowUnimportantMetadataFields"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSmartTagging"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSubjectExtractionType"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedSystemLanguage"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTextRecognition"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTranslationLanguagesAdded"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTranslationLanguagesRemoved"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedTwoFactorAuth"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedUseAlreadyIncludedKeywords"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoForceConversion"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoMaxDuration"
},
{
"$ref": "#/components/schemas/GeneralSettingsModifiedVideoMaxSize"
},
{
"title": "IdentityProviderCreated",
"type": "object"
},
{
"title": "IdentityProviderDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedAuthorizationEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedClientID"
},
{
"title": "IdentityProviderModifiedClientSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedIsActive"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedMetadataEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedName"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedTokenEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedUserEndpoint"
},
{
"$ref": "#/components/schemas/IdentityProviderModifiedUserField"
},
{
"title": "ImportantMetadataCreated",
"type": "object"
},
{
"title": "ImportantMetadataDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedIsEditable"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedIsIndexed"
},
{
"$ref": "#/components/schemas/ImportantMetadataModifiedOrder"
},
{
"title": "KeywordCreated",
"type": "object"
},
{
"title": "KeywordDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/KeywordModifiedPermissionGroupIDsAdded"
},
{
"$ref": "#/components/schemas/KeywordModifiedPermissionGroupIDsRemoved"
},
{
"title": "LicenseCreated",
"type": "object"
},
{
"title": "LicenseDeleted",
"type": "object"
},
{
"title": "LicenseFileCreated",
"type": "object"
},
{
"title": "LicenseFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedColor"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedCreateDate"
},
{
"title": "LicenseFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedInfosAdded"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedInfosRemoved"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/LicenseFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/LicenseModifiedProvider"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedContentName"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedContentValue"
},
{
"$ref": "#/components/schemas/LicenseReleaseDataTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/LicenseReleaseTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/LicenseReleaseTranslationModifiedName"
},
{
"$ref": "#/components/schemas/LoginAttempted"
},
{
"title": "MessageCenterCreated",
"type": "object"
},
{
"title": "MessageCenterDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedCollectionsAdded"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedCollectionsRemoved"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationByApplication"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationByEmail"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationDayTime"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationInterval"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationMonthDay"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotificationWeekDay"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionDeleted"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionEdited"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionMessagingWithoutSubscription"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionShared"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyCollectionSharedInternalWithMe"
},
{
"$ref": "#/components/schemas/MessageCenterModifiedNotifyExternalSharedCollectionOpened"
},
{
"title": "MetadataFieldCreated",
"type": "object"
},
{
"title": "MetadataFieldDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedEditType"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIndexedForSearchTerm"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIsImportant"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedIsSearchable"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedName"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsAdded"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsRemoved"
},
{
"$ref": "#/components/schemas/MetadataFieldModifiedSelectionTermsRenamed"
},
{
"title": "ModelCreated",
"type": "object"
},
{
"title": "ModelDeleted",
"type": "object"
},
{
"title": "ModelFileCreated",
"type": "object"
},
{
"title": "ModelFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ModelFileModifiedColor"
},
{
"$ref": "#/components/schemas/ModelFileModifiedCreateDate"
},
{
"title": "ModelFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/ModelFileModifiedName"
},
{
"$ref": "#/components/schemas/ModelFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/ModelFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/ModelFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/ModelModifiedBirthDate"
},
{
"$ref": "#/components/schemas/ModelModifiedEmail"
},
{
"$ref": "#/components/schemas/ModelModifiedFirstName"
},
{
"$ref": "#/components/schemas/ModelModifiedLastName"
},
{
"title": "NewFileCreated",
"type": "object"
},
{
"title": "PermissionGroupCreated",
"type": "object"
},
{
"title": "PermissionGroupDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCommentFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateKeywords"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreatePortals"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedCreateUploadLinks"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDefaultUploadFileState"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteForeignCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteForeignFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteOwnCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDeleteOwnFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToCreateRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToEditRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToShowRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDirectoryIDsToUploadRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDownloadFormatIDsAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedDownloadFormatIDsRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditDesign"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditFilesInHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditFilesInInternalSharedCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditForeignCollections"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditForeignFiles"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditLicenses"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedEditUsers"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToAssignRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowAll"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedFileStatesToShowRemoved"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceExportProof"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatFree"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatOriginal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedHasDownloadFormatPreview"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedIsAdmin"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedIsExternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedLinked"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedModifyDirectoriesInHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedName"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsExternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsInternal"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareCollectionsNetwork"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShareFilesNetwork"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedShowAllCustomDownloadFormats"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUnlinked"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadFilesToHomeDirectory"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadObligationsAdded"
},
{
"$ref": "#/components/schemas/PermissionGroupModifiedUploadObligationsRemoved"
},
{
"$ref": "#/components/schemas/PortalCollectionModifiedIsProtected"
},
{
"$ref": "#/components/schemas/PortalCollectionModifiedOrder"
},
{
"title": "PortalCreated",
"type": "object"
},
{
"title": "PortalDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedActivateUserAutomatically"
},
{
"$ref": "#/components/schemas/PortalModifiedAddShadowToFont"
},
{
"$ref": "#/components/schemas/PortalModifiedAutomaticallyActivatedDomainsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedAutomaticallyActivatedDomainsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedBackgroundColor"
},
{
"$ref": "#/components/schemas/PortalModifiedBrandURL"
},
{
"title": "PortalModifiedBrandingLogoImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionAssetNavigator"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedCollectionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedCookieLinkPrivacyPage"
},
{
"$ref": "#/components/schemas/PortalModifiedCookiePlacement"
},
{
"$ref": "#/components/schemas/PortalModifiedCustomMetadataIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedCustomMetadataIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedDefaultMetadataFieldsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedDefaultMetadataFieldsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedEmailReceiver"
},
{
"$ref": "#/components/schemas/PortalModifiedFilterOptionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedFilterOptionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/PortalModifiedForceWatermark"
},
{
"title": "PortalModifiedGeneralPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHasUserRegistration"
},
{
"$ref": "#/components/schemas/PortalModifiedHasWhitelabel"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroArrowColor"
},
{
"title": "PortalModifiedHeroBannerImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroFontColor"
},
{
"$ref": "#/components/schemas/PortalModifiedHeroLogoColor"
},
{
"title": "PortalModifiedHeroLogoImage",
"type": "object"
},
{
"$ref": "#/components/schemas/PortalModifiedHostNames"
},
{
"$ref": "#/components/schemas/PortalModifiedIsActive"
},
{
"$ref": "#/components/schemas/PortalModifiedLandingPageOptions"
},
{
"$ref": "#/components/schemas/PortalModifiedLanguagesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedLanguagesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedLicenseReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedLicenseReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedMainHostName"
},
{
"$ref": "#/components/schemas/PortalModifiedMediaViewsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedMediaViewsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedModelReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedModelReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedName"
},
{
"$ref": "#/components/schemas/PortalModifiedOriginalDownloadFormatTypesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedOriginalDownloadFormatTypesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPageName"
},
{
"$ref": "#/components/schemas/PortalModifiedPageText"
},
{
"$ref": "#/components/schemas/PortalModifiedPagesAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPagesRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPlacementsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPlacementsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedPreferredMode"
},
{
"$ref": "#/components/schemas/PortalModifiedPreferredTitle"
},
{
"$ref": "#/components/schemas/PortalModifiedPropertyReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedPropertyReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedRestrictAccess"
},
{
"$ref": "#/components/schemas/PortalModifiedSearchFieldsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedSearchFieldsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/PortalModifiedShowBorder"
},
{
"$ref": "#/components/schemas/PortalModifiedShowCookieInformation"
},
{
"$ref": "#/components/schemas/PortalModifiedShowCreateLinkToFileTab"
},
{
"$ref": "#/components/schemas/PortalModifiedShowFileType"
},
{
"$ref": "#/components/schemas/PortalModifiedShowLicenseReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowModelReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowPropertyReleaseFile"
},
{
"$ref": "#/components/schemas/PortalModifiedShowStartScreen"
},
{
"$ref": "#/components/schemas/PortalModifiedSortOptionsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedSortOptionsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedStandardMetadataIDsAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedStandardMetadataIDsRemoved"
},
{
"$ref": "#/components/schemas/PortalModifiedUseSSO"
},
{
"$ref": "#/components/schemas/PortalModifiedUseSemanticSearch"
},
{
"$ref": "#/components/schemas/PortalModifiedUserCompany"
},
{
"$ref": "#/components/schemas/PortalModifiedUserDepartment"
},
{
"$ref": "#/components/schemas/PortalModifiedUserEmail"
},
{
"$ref": "#/components/schemas/PortalModifiedUserFirstName"
},
{
"$ref": "#/components/schemas/PortalModifiedUserIsActive"
},
{
"$ref": "#/components/schemas/PortalModifiedUserIsConfirmed"
},
{
"$ref": "#/components/schemas/PortalModifiedUserLanguage"
},
{
"$ref": "#/components/schemas/PortalModifiedUserLastName"
},
{
"$ref": "#/components/schemas/PortalModifiedUserPassword"
},
{
"$ref": "#/components/schemas/PortalModifiedUsersAdded"
},
{
"$ref": "#/components/schemas/PortalModifiedUsersRemoved"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedName"
},
{
"$ref": "#/components/schemas/PortalPageTranslationModifiedText"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedCookieTextShort"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedFooterText"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedHeroSlogan"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PortalTranslationModifiedStartScreenText"
},
{
"title": "PropertyCreated",
"type": "object"
},
{
"title": "PropertyDeleted",
"type": "object"
},
{
"title": "PropertyFileCreated",
"type": "object"
},
{
"title": "PropertyFileDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedColor"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedCreateDate"
},
{
"title": "PropertyFileModifiedFile",
"type": "object"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedName"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedShowFile"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedShowWarningMessage"
},
{
"$ref": "#/components/schemas/PropertyFileModifiedWarningMessage"
},
{
"$ref": "#/components/schemas/PropertyModifiedAddress"
},
{
"$ref": "#/components/schemas/PropertyModifiedName"
},
{
"$ref": "#/components/schemas/PropertyModifiedOwner"
},
{
"$ref": "#/components/schemas/PropertyReleaseTranslationModifiedLanguage"
},
{
"$ref": "#/components/schemas/PropertyReleaseTranslationModifiedName"
},
{
"title": "ReportCreated",
"type": "object"
},
{
"title": "ReportDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/ReportModifiedAdditionalText"
},
{
"$ref": "#/components/schemas/ReportModifiedDayInMonth"
},
{
"$ref": "#/components/schemas/ReportModifiedDayInWeek"
},
{
"$ref": "#/components/schemas/ReportModifiedDayTime"
},
{
"$ref": "#/components/schemas/ReportModifiedIsActive"
},
{
"$ref": "#/components/schemas/ReportModifiedName"
},
{
"$ref": "#/components/schemas/ReportModifiedReceiverEmailsAdded"
},
{
"$ref": "#/components/schemas/ReportModifiedReceiverEmailsRemoved"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsAdded"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsRemoved"
},
{
"$ref": "#/components/schemas/ReportModifiedReportEventsReplaced"
},
{
"$ref": "#/components/schemas/ReportModifiedReportInterval"
},
{
"$ref": "#/components/schemas/ReportModifiedReportWhenNoData"
},
{
"$ref": "#/components/schemas/ReportModifiedSendCSV"
},
{
"$ref": "#/components/schemas/ReportModifiedSendPDF"
},
{
"$ref": "#/components/schemas/SettingsModifiedCustomJavaScript"
},
{
"$ref": "#/components/schemas/SettingsModifiedDateFormat"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCollectionSyncHostName"
},
{
"title": "SettingsModifiedExternalCollectionSyncPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCollectionSyncUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalCustomCss"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalShareHostName"
},
{
"title": "SettingsModifiedExternalSharePassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedExternalShareUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedFaviconFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedFaviconText"
},
{
"$ref": "#/components/schemas/SettingsModifiedFont"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBigDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBigLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoBootFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoDarkFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoIconDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoIconLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedLogoLink"
},
{
"$ref": "#/components/schemas/SettingsModifiedPrimaryColorDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedPrimaryColorLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedProxyHostName"
},
{
"$ref": "#/components/schemas/SettingsModifiedProxyPort"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPHasSSL"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPHostName"
},
{
"title": "SettingsModifiedSMTPPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPPort"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPTransmitterEmail"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPTransmitterName"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPUseDefault"
},
{
"$ref": "#/components/schemas/SettingsModifiedSMTPUserName"
},
{
"$ref": "#/components/schemas/SettingsModifiedSecondaryColorDark"
},
{
"$ref": "#/components/schemas/SettingsModifiedSecondaryColorLight"
},
{
"$ref": "#/components/schemas/SettingsModifiedSloganStartscreen"
},
{
"$ref": "#/components/schemas/SettingsModifiedStartscreenFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedUploadLinkBackgroundFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkFile"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomMiddle"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsBottomRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsCenter"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsMiddleLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsMiddleRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperLeft"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperMiddle"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositionIsUpperRight"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkPositioningType"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkText"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkTransparency"
},
{
"$ref": "#/components/schemas/SettingsModifiedWatermarkWidthPercent"
},
{
"title": "SpaceCreated",
"type": "object"
},
{
"title": "SpaceDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceModifiedAutomaticallyActivatedDomainsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedAutomaticallyActivatedDomainsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedCopyrightText"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomBodyFontFileID"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomHeadingsFontFileID"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomMetadataIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedCustomization"
},
{
"$ref": "#/components/schemas/SpaceModifiedDefaultMetadataFields"
},
{
"$ref": "#/components/schemas/SpaceModifiedDownloadFormatsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedDownloadFormatsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedFaviconImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedForceDownloadProof"
},
{
"$ref": "#/components/schemas/SpaceModifiedForceWatermark"
},
{
"$ref": "#/components/schemas/SpaceModifiedHostNames"
},
{
"$ref": "#/components/schemas/SpaceModifiedIsActive"
},
{
"$ref": "#/components/schemas/SpaceModifiedLanguagesAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedLanguagesRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedLicenseReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginBackgroundImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginHeadline"
},
{
"$ref": "#/components/schemas/SpaceModifiedLoginRequired"
},
{
"$ref": "#/components/schemas/SpaceModifiedLogoDarkImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedLogoLightImage"
},
{
"$ref": "#/components/schemas/SpaceModifiedMainHostName"
},
{
"$ref": "#/components/schemas/SpaceModifiedModelReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedName"
},
{
"$ref": "#/components/schemas/SpaceModifiedOriginalDownloadFormatTypesAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedOriginalDownloadFormatTypesRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedPermissionGroupsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedPermissionGroupsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedPreferredTitle"
},
{
"$ref": "#/components/schemas/SpaceModifiedPrimaryColor"
},
{
"$ref": "#/components/schemas/SpaceModifiedPropertyReleaseIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedSearchFieldsAdded"
},
{
"$ref": "#/components/schemas/SpaceModifiedSearchFieldsRemoved"
},
{
"$ref": "#/components/schemas/SpaceModifiedSecondaryColor"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowFileType"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowLicenseReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowModelReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowPropertyReleaseFile"
},
{
"$ref": "#/components/schemas/SpaceModifiedShowTermsOfUse"
},
{
"$ref": "#/components/schemas/SpaceModifiedStandardMetadataIDs"
},
{
"$ref": "#/components/schemas/SpaceModifiedStartScreenPage"
},
{
"$ref": "#/components/schemas/SpaceModifiedTermsOfUse"
},
{
"$ref": "#/components/schemas/SpaceModifiedUseSSO"
},
{
"$ref": "#/components/schemas/SpaceModifiedUseSemanticSearch"
},
{
"title": "SpaceNavigationFooterCreated",
"type": "object"
},
{
"title": "SpaceNavigationFooterDeleted",
"type": "object"
},
{
"title": "SpaceNavigationHeaderCreated",
"type": "object"
},
{
"title": "SpaceNavigationHeaderDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedAnchor"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterFooterText"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterName"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedFooterOrder"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedHeaderName"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedHeaderOrder"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedLink"
},
{
"$ref": "#/components/schemas/SpaceNavigationModifiedSpacePageID"
},
{
"title": "SpacePageCreated",
"type": "object"
},
{
"title": "SpacePageDeleted",
"type": "object"
},
{
"title": "SpacePageModifiedContent",
"type": "object"
},
{
"$ref": "#/components/schemas/SpacePageModifiedName"
},
{
"$ref": "#/components/schemas/SpacePageModifiedSlug"
},
{
"title": "SpacePageTemplateCreated",
"type": "object"
},
{
"title": "SpacePageTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpacePageTemplateUpdated"
},
{
"title": "SpaceTemplateCreated",
"type": "object"
},
{
"title": "SpaceTemplateDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SpaceTemplateUpdated"
},
{
"title": "StandardMetadataCreated",
"type": "object"
},
{
"title": "StandardMetadataDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/StandardMetadataModifiedValue"
},
{
"$ref": "#/components/schemas/StandardMetadataModifiedValueType"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym1"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym10"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym11"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym12"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym13"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym14"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym15"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym16"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym17"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym18"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym19"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym2"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym20"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym3"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym4"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym5"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym6"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym7"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym8"
},
{
"$ref": "#/components/schemas/SynonymColumnsModifiedSynonym9"
},
{
"title": "SynonymCreated",
"type": "object"
},
{
"title": "SynonymDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/SynonymModifiedSynonym"
},
{
"$ref": "#/components/schemas/TenantModifiedAdditionalDiskSpaceGigaByte"
},
{
"$ref": "#/components/schemas/TenantModifiedExpirationDate"
},
{
"$ref": "#/components/schemas/TenantModifiedIsPaused"
},
{
"$ref": "#/components/schemas/TenantModifiedMediaPortalLimit"
},
{
"$ref": "#/components/schemas/TenantModifiedReadOnlyUserLimit"
},
{
"$ref": "#/components/schemas/TenantModifiedUserLimit"
},
{
"$ref": "#/components/schemas/TrashCreated"
},
{
"title": "TrashDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/TrashRestored"
},
{
"title": "UploadLinkCreated",
"type": "object"
},
{
"title": "UploadLinkDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/UploadLinkFileUploaded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedDescription"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedDirectoryID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedEmailsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFaceRecognitionDisabled"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFileStateID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedIsDisabled"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedKeywordsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedKeywordsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedLicenseReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedLicenseReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedModelReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedModelReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedName"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedNotificationText"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedPropertyReleaseIDsAdded"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedPropertyReleaseIDsRemoved"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllLicenseReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllModelReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedShowAllPropertyReleases"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedUploadCondition"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedUserID"
},
{
"$ref": "#/components/schemas/UploadLinkModifiedValidityPeriod"
},
{
"title": "UserCreated",
"type": "object"
},
{
"title": "UserDeleted",
"type": "object"
},
{
"title": "UserModifiedCIFSPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedEmail"
},
{
"$ref": "#/components/schemas/UserModifiedFirstName"
},
{
"$ref": "#/components/schemas/UserModifiedIsActive"
},
{
"$ref": "#/components/schemas/UserModifiedIsExternal"
},
{
"$ref": "#/components/schemas/UserModifiedLanguage"
},
{
"$ref": "#/components/schemas/UserModifiedLastName"
},
{
"$ref": "#/components/schemas/UserModifiedLinked"
},
{
"title": "UserModifiedPassword",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedPermissionGroupIDsAdded"
},
{
"$ref": "#/components/schemas/UserModifiedPermissionGroupIDsRemoved"
},
{
"$ref": "#/components/schemas/UserModifiedRefreshToken"
},
{
"$ref": "#/components/schemas/UserModifiedResetPasswordStamp"
},
{
"$ref": "#/components/schemas/UserModifiedResetPasswordToken"
},
{
"title": "UserModifiedSecret",
"type": "object"
},
{
"$ref": "#/components/schemas/UserModifiedSecretExpirationDate"
},
{
"$ref": "#/components/schemas/UserModifiedTwoFactorAuthSetUp"
},
{
"$ref": "#/components/schemas/UserModifiedUnlinked"
},
{
"$ref": "#/components/schemas/UserModifiedUserName"
},
{
"title": "UserTrackingCreated",
"type": "object"
},
{
"title": "UserTrackingDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/UserTrackingModifiedFirstMonthlyLogin"
},
{
"$ref": "#/components/schemas/UserTrackingModifiedUserID"
},
{
"title": "VariantStackCreated",
"type": "object"
},
{
"title": "VariantStackDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/VariantStackModifiedDescription"
},
{
"$ref": "#/components/schemas/VariantStackModifiedFilesAdded"
},
{
"$ref": "#/components/schemas/VariantStackModifiedFilesRemoved"
},
{
"$ref": "#/components/schemas/VariantStackModifiedName"
},
{
"title": "WebhookCreated",
"type": "object"
},
{
"title": "WebhookDeleted",
"type": "object"
},
{
"$ref": "#/components/schemas/WebhookModifiedDescription"
},
{
"$ref": "#/components/schemas/WebhookModifiedEventKeysAdded"
},
{
"$ref": "#/components/schemas/WebhookModifiedEventKeysRemoved"
},
{
"$ref": "#/components/schemas/WebhookModifiedName"
},
{
"$ref": "#/components/schemas/WebhookModifiedURL"
},
{
"title": "WebhookModifiedWebhookSecret",
"type": "object"
}
],
"title": "EventDataOnlyApplication",
"type": "object"
},
"EventOnlyApplication": {
"properties": {
"action": {
"description": "An Event action",
"enum": [
"attempted",
"created",
"deleted",
"downloaded",
"indexed",
"replaced",
"replacedPreviewFile",
"restoredPreviewFile",
"sharedExternally",
"sharedInternally",
"updated",
"viewed"
],
"example": "viewed",
"title": "EventAction",
"type": "string"
},
"applicationKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"applicationName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"cause": {
"description": "The cause of an event.",
"enum": [
"batchTenant",
"clarifaiScan",
"clearDownloadCache",
"computeGroupsAzureActiveDirectory",
"createAPIKey",
"createAdministrationServer",
"createAssetNavigator",
"createAssetNavigatorCategory",
"createAzureActiveDirectory",
"createCollection",
"createComment",
"createCustomMetadata",
"createDirectLink",
"createDirectory",
"createDownload",
"createDownloadFormat",
"createEmailCustomTemplate",
"createExternalShare",
"createExternalSharesComment",
"createExternalSharesUpvote",
"createFile",
"createFileState",
"createFilter",
"createHost",
"createIdentityProvider",
"createImportantMetadata",
"createKeyword",
"createLicense",
"createLicenseRelease",
"createMetadataField",
"createModel",
"createModelRelease",
"createPackage",
"createPackagePortal",
"createPermissionGroup",
"createPlugin",
"createPortal",
"createPortalAssetNavigator",
"createPortalPage",
"createPortalUser",
"createProperty",
"createPropertyRelease",
"createReport",
"createSpace",
"createSpaceNavigationFooter",
"createSpaceNavigationFooterLink",
"createSpaceNavigationHeader",
"createSpaceNavigationHeaderCategory",
"createSpacePage",
"createSpacePageTemplate",
"createSpaceTemplate",
"createStandardMetadata",
"createSystem",
"createTrash",
"createUploadLink",
"createUser",
"createUserTracking",
"createVariantStack",
"createVersionStackFile",
"createWebhook",
"deleteAPIKey",
"deleteAdministrationServer",
"deleteAssetNavigator",
"deleteAssetNavigatorCategory",
"deleteAzureActiveDirectory",
"deleteCollection",
"deleteComment",
"deleteCustomMetadata",
"deleteDirectLink",
"deleteDirectory",
"deleteDownload",
"deleteDownloadFormat",
"deleteDuplicateFile",
"deleteEmailCustomTemplate",
"deleteExternalShare",
"deleteExternalSharesComment",
"deleteExternalSharesUpvote",
"deleteFile",
"deleteFileState",
"deleteFilter",
"deleteHost",
"deleteIdentityProvider",
"deleteImportantMetadata",
"deleteKeyword",
"deleteLicense",
"deleteLicenseRelease",
"deleteMetadataField",
"deleteModel",
"deleteModelRelease",
"deletePackage",
"deletePackagePortal",
"deletePermissionGroup",
"deletePlugin",
"deletePortal",
"deletePortalAssetNavigator",
"deletePortalPage",
"deletePortalUser",
"deleteProperty",
"deletePropertyRelease",
"deleteReport",
"deleteSettingsClarifai",
"deleteSettingsDownloadCache",
"deleteSettingsOpenStreetMap",
"deleteSettingsSMTPServer",
"deleteSpace",
"deleteSpaceNavigationFooter",
"deleteSpaceNavigationFooterLink",
"deleteSpaceNavigationHeader",
"deleteSpaceNavigationHeaderCategory",
"deleteSpacePage",
"deleteSpacePageTemplate",
"deleteSpaceTemplate",
"deleteStandardMetadata",
"deleteSynonym",
"deleteSystem",
"deleteTrash",
"deleteUploadLink",
"deleteUser",
"deleteUserTracking",
"deleteVariantStack",
"deleteWebhook",
"doubleOptInConfirmPortalUser",
"downloadFile",
"featureActivate",
"featureDeactivate",
"fileModifiedFaces",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedRecognizedText",
"indexFinished",
"ldapComputeGroups",
"ldapSync",
"loginAttempted",
"messageQueueJobFinished",
"metadataFieldEditTypeNormalization",
"replacePreviewFileFile",
"resetPasswordConfirmPortalUser",
"resetPasswordConfirmUser",
"restorePreviewFileFile",
"scanFilesClarifai",
"scanFilesOpenStreetMap",
"syncAzureActiveDirectory",
"testController",
"updateAPIKey",
"updateAdministrationServer",
"updateAssetNavigator",
"updateAssetNavigatorCategory",
"updateAssetNavigatorCategoryTranslation",
"updateAzureActiveDirectory",
"updateCollection",
"updateCollectionTranslation",
"updateCustomMetadata",
"updateCustomMetadataOption",
"updateDefaultMetadataField",
"updateDirectLink",
"updateDirectory",
"updateDownload",
"updateDownloadFormat",
"updateDownloadFormatTranslation",
"updateEmailCustomTemplate",
"updateExternalShare",
"updateFile",
"updateFileState",
"updateFilter",
"updateHost",
"updateIdentityProvider",
"updateImportantMetadata",
"updateLicense",
"updateLicenseRelease",
"updateLicenseReleaseTranslation",
"updateMainVersionFile",
"updateMessageCenter",
"updateMessages",
"updateMetadataField",
"updateModel",
"updateModelRelease",
"updateModelReleaseTranslation",
"updatePackage",
"updatePackagePortal",
"updatePermissionGroup",
"updatePlugin",
"updatePortal",
"updatePortalAssetNavigator",
"updatePortalCollection",
"updatePortalPage",
"updatePortalPageTranslation",
"updatePortalTranslation",
"updatePortalUser",
"updateProperty",
"updatePropertyRelease",
"updatePropertyReleaseTranslation",
"updateReport",
"updateSettingsClarifai",
"updateSettingsDesign",
"updateSettingsDownloadCache",
"updateSettingsGeneral",
"updateSettingsOpenStreetMap",
"updateSettingsSMTPServer",
"updateSettingsWatermark",
"updateSpace",
"updateSpaceNavigationFooter",
"updateSpaceNavigationFooterLink",
"updateSpaceNavigationHeader",
"updateSpaceNavigationHeaderCategory",
"updateSpacePage",
"updateSpacePageTemplate",
"updateSpaceTemplate",
"updateStandardMetadata",
"updateSystem",
"updateTrash",
"updateUploadLink",
"updateUser",
"updateUserTracking",
"updateVariantStack",
"updateWebhook",
"uploadCSVKeyword",
"uploadCSVSynonym",
"uploadFile",
"viewExternalShare"
],
"example": "createFile",
"title": "EventCause",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"data": {
"$ref": "#/components/schemas/EventDataOnlyApplication"
},
"eventKey": {
"description": "EventKey represents the key of an event.",
"enum": [
"apiKeyCreated",
"apiKeyDeleted",
"apiKeyModifiedIPRangeAdded",
"apiKeyModifiedIPRangeRemoved",
"apiKeyModifiedIsActive",
"apiKeyModifiedName",
"apiKeyModifiedScopeID",
"apiKeyModifiedUserID",
"assetNavigatorCategoryCreated",
"assetNavigatorCategoryDeleted",
"assetNavigatorCategoryModifiedMetadataFieldID",
"assetNavigatorCategoryModifiedOrder",
"assetNavigatorCategoryTranslationCreated",
"assetNavigatorCategoryTranslationModifiedLanguage",
"assetNavigatorCategoryTranslationModifiedName",
"assetNavigatorCreated",
"assetNavigatorDeleted",
"assetNavigatorModifiedAssetNavigatorCategory",
"assetNavigatorModifiedDescription",
"assetNavigatorModifiedName",
"azureActiveDirectoryCreated",
"azureActiveDirectoryDeleted",
"azureActiveDirectoryModifiedClientID",
"azureActiveDirectoryModifiedClientSecret",
"azureActiveDirectoryModifiedDeleteMode",
"azureActiveDirectoryModifiedGroupUpdated",
"azureActiveDirectoryModifiedGroupsActivated",
"azureActiveDirectoryModifiedGroupsAdded",
"azureActiveDirectoryModifiedGroupsDeactivated",
"azureActiveDirectoryModifiedGroupsRemoved",
"azureActiveDirectoryModifiedIPRangeAdded",
"azureActiveDirectoryModifiedIPRangeRemoved",
"azureActiveDirectoryModifiedName",
"azureActiveDirectoryModifiedNewUserDataOwner",
"azureActiveDirectoryModifiedRecursive",
"azureActiveDirectoryModifiedSyncTime",
"azureActiveDirectoryModifiedTenantID",
"collectionCreated",
"collectionDeleted",
"collectionModifiedAssetNavigatorID",
"collectionModifiedFilesAdded",
"collectionModifiedFilesCommented",
"collectionModifiedFilesRemoved",
"collectionModifiedPreviewFileIDs",
"collectionModifiedUserID",
"collectionSharedExternally",
"collectionSharedInternally",
"collectionTranslationCreated",
"collectionTranslationDeleted",
"collectionTranslationModifiedDescription",
"collectionTranslationModifiedLanguage",
"collectionTranslationModifiedName",
"collectionUnsharedInternally",
"commentCreated",
"commentDeleted",
"customMetadataCreated",
"customMetadataDeleted",
"customMetadataLanguagesCreated",
"customMetadataLanguagesDeleted",
"customMetadataLanguagesModifiedName",
"customMetadataModifiedParentConditionCustomMetadataID",
"customMetadataModifiedParentConditionCustomMetadataOptionIDs",
"customMetadataOptionLanguagesCreated",
"customMetadataOptionLanguagesDeleted",
"customMetadataOptionLanguagesModifiedName",
"customMetadataOptionsCreated",
"customMetadataOptionsDeleted",
"customMetadataOptionsModifiedOrder",
"customMetadataParentConditionCreated",
"customMetadataParentConditionDeleted",
"directLinkCreated",
"directLinkDeleted",
"directLinkModifiedDownloadFormatID",
"directLinkModifiedFileID",
"directLinkModifiedFileName",
"directLinkModifiedFileSize",
"directoryCreated",
"directoryDeleted",
"directoryModifiedName",
"directoryModifiedParentDirectoryID",
"downloadCreated",
"downloadDeleted",
"downloadFormatCreated",
"downloadFormatDeleted",
"downloadFormatModifiedColorspace",
"downloadFormatModifiedDensity",
"downloadFormatModifiedFormatConversion",
"downloadFormatModifiedHeight",
"downloadFormatModifiedName",
"downloadFormatModifiedQuality",
"downloadFormatModifiedResize",
"downloadFormatModifiedResizeUnit",
"downloadFormatModifiedWidth",
"downloadFormatTranslationCreated",
"downloadFormatTranslationModifiedLanguage",
"downloadFormatTranslationModifiedName",
"downloadModifiedDownloadFormatID",
"downloadModifiedFileIDsAdded",
"downloadModifiedFileIDsRemoved",
"downloadModifiedUserID",
"downloadModifiedUserName",
"duplicateFileCreated",
"duplicateFileDeleted",
"emailCustomTemplateCreated",
"emailCustomTemplateDeleted",
"emailCustomTemplateModifiedBody",
"emailCustomTemplateModifiedLanguage",
"emailCustomTemplateModifiedName",
"emailCustomTemplateModifiedSubject",
"emailCustomTemplateModifiedType",
"externalShareCreated",
"externalShareDeleted",
"externalShareModifiedAllowComments",
"externalShareModifiedAllowDownloads",
"externalShareModifiedAllowUpvotes",
"externalShareModifiedDescription",
"externalShareModifiedDownloadFormatsAdded",
"externalShareModifiedDownloadFormatsRemoved",
"externalShareModifiedEmailsAdded",
"externalShareModifiedFileDetailsAdded",
"externalShareModifiedFileDetailsRemoved",
"externalShareModifiedFilesAdded",
"externalShareModifiedFilesRemoved",
"externalShareModifiedForceDownloadProof",
"externalShareModifiedForceWatermark",
"externalShareModifiedHasDownloadFormatFree",
"externalShareModifiedHasDownloadFormatOriginal",
"externalShareModifiedHasDownloadFormatPreview",
"externalShareModifiedIsDisabled",
"externalShareModifiedMediaViewsAdded",
"externalShareModifiedMediaViewsRemoved",
"externalShareModifiedName",
"externalShareModifiedNotificationText",
"externalShareModifiedPassword",
"externalShareModifiedTermsOfUse",
"externalShareModifiedUserID",
"externalShareModifiedValidityPeriod",
"externalShareViewed",
"externalSharesCommentCreated",
"externalSharesCommentDeleted",
"externalSharesUpvoteCreated",
"externalSharesUpvoteDeleted",
"fileCreated",
"fileDeleted",
"fileDeletedDuplicate",
"fileDownloaded",
"fileModifiedCollectionIDsAdded",
"fileModifiedCollectionIDsRemoved",
"fileModifiedCreateDate",
"fileModifiedCreator",
"fileModifiedDescription",
"fileModifiedDirectoryIDPath",
"fileModifiedExternalShareIDsAdded",
"fileModifiedExternalShareIDsRemoved",
"fileModifiedFaces",
"fileModifiedFileName",
"fileModifiedFileStateID",
"fileModifiedIsCheckedOut",
"fileModifiedIsDownloadLocked",
"fileModifiedKeywordsAdded",
"fileModifiedKeywordsDeleted",
"fileModifiedKeywordsRecognitionAdded",
"fileModifiedKeywordsRecognitionDeleted",
"fileModifiedLanguageCodesAdded",
"fileModifiedLanguageCodesRemoved",
"fileModifiedLicenseFilesAdded",
"fileModifiedLicenseFilesDeleted",
"fileModifiedLocation",
"fileModifiedMainVersionFileID",
"fileModifiedMarkedUserIDsAdded",
"fileModifiedMarkedUserIDsRemoved",
"fileModifiedMetadataFieldDate",
"fileModifiedMetadataFieldFocalPoint",
"fileModifiedMetadataFieldLanguagesAdded",
"fileModifiedMetadataFieldLanguagesDeleted",
"fileModifiedMetadataFieldLocation",
"fileModifiedMetadataFieldMultiSelectionsAdded",
"fileModifiedMetadataFieldMultiSelectionsDeleted",
"fileModifiedMetadataFieldOrientation",
"fileModifiedMetadataFieldSelection",
"fileModifiedMetadataFieldText",
"fileModifiedMetadataFieldTruncate",
"fileModifiedModelFilesAdded",
"fileModifiedModelFilesDeleted",
"fileModifiedPropertyFilesAdded",
"fileModifiedPropertyFilesDeleted",
"fileModifiedRating",
"fileModifiedRecognizedText",
"fileModifiedRotation",
"fileModifiedSubject",
"fileModifiedUploadDate",
"fileModifiedUploadLink",
"fileModifiedUserID",
"fileModifiedVariantStack",
"fileReplaced",
"fileReplacedPreviewFile",
"fileRestoredPreviewFile",
"fileStateCreated",
"fileStateDeleted",
"fileStateModifiedColor",
"fileStateModifiedDescription",
"fileStateModifiedForceComment",
"fileStateModifiedIsArchive",
"fileStateModifiedName",
"fileStateModifiedOrder",
"filesCustomFieldCreated",
"filesCustomFieldDeleted",
"filesCustomFieldModifiedValue",
"filesCustomFieldModifiedValueCustomFieldsOptionID",
"filesCustomFieldModifiedValueCustomFieldsOptionIDs",
"filterCreated",
"filterDeleted",
"filterModifiedFilter",
"filterModifiedName",
"filterModifiedUserID",
"generalSettingsModifiedAllowConcurrentLogin",
"generalSettingsModifiedAllowDuplicates",
"generalSettingsModifiedCheckSessionFiles",
"generalSettingsModifiedDailyAPILimit",
"generalSettingsModifiedDataPrivacyText",
"generalSettingsModifiedDataPrivacyURL",
"generalSettingsModifiedDefaultLanguageCodesAdded",
"generalSettingsModifiedDefaultLanguageCodesRemoved",
"generalSettingsModifiedDirectoriesInMediaview",
"generalSettingsModifiedDownloadCacheSize",
"generalSettingsModifiedDownloadCacheStoreCroppedFiles",
"generalSettingsModifiedDownloadCacheTime",
"generalSettingsModifiedDownloadLockedText",
"generalSettingsModifiedEnableForgotPasswordOption",
"generalSettingsModifiedExternalShareAlias",
"generalSettingsModifiedFaceRecognition",
"generalSettingsModifiedGeneralUploadText",
"generalSettingsModifiedKeywordUploadText",
"generalSettingsModifiedKeywordsBoundToPermissionGroups",
"generalSettingsModifiedLegalNoticeText",
"generalSettingsModifiedLegalNoticeURL",
"generalSettingsModifiedMetadataFieldsOrder",
"generalSettingsModifiedPasswordSecurityLevel",
"generalSettingsModifiedSecondAPILimit",
"generalSettingsModifiedSemanticSearch",
"generalSettingsModifiedSessionTimeout",
"generalSettingsModifiedShowChat",
"generalSettingsModifiedShowFileOwner",
"generalSettingsModifiedShowUnimportantMetadataFields",
"generalSettingsModifiedSmartTagging",
"generalSettingsModifiedSubjectExtractionType",
"generalSettingsModifiedSystemLanguage",
"generalSettingsModifiedTextRecognition",
"generalSettingsModifiedTranslationLanguagesAdded",
"generalSettingsModifiedTranslationLanguagesRemoved",
"generalSettingsModifiedTwoFactorAuth",
"generalSettingsModifiedUseAlreadyIncludedKeywords",
"generalSettingsModifiedVideoForceConversion",
"generalSettingsModifiedVideoMaxDuration",
"generalSettingsModifiedVideoMaxSize",
"identityProviderCreated",
"identityProviderDeleted",
"identityProviderModifiedAuthorizationEndpoint",
"identityProviderModifiedClientID",
"identityProviderModifiedClientSecret",
"identityProviderModifiedIsActive",
"identityProviderModifiedMetadataEndpoint",
"identityProviderModifiedName",
"identityProviderModifiedTokenEndpoint",
"identityProviderModifiedUserEndpoint",
"identityProviderModifiedUserField",
"importantMetadataCreated",
"importantMetadataDeleted",
"importantMetadataModifiedIsEditable",
"importantMetadataModifiedIsIndexed",
"importantMetadataModifiedOrder",
"keywordCreated",
"keywordDeleted",
"keywordModifiedPermissionGroupIDsAdded",
"keywordModifiedPermissionGroupIDsRemoved",
"licenseCreated",
"licenseDeleted",
"licenseFileCreated",
"licenseFileDeleted",
"licenseFileModifiedColor",
"licenseFileModifiedCreateDate",
"licenseFileModifiedFile",
"licenseFileModifiedInfosAdded",
"licenseFileModifiedInfosRemoved",
"licenseFileModifiedName",
"licenseFileModifiedShowFile",
"licenseFileModifiedShowWarningMessage",
"licenseFileModifiedWarningMessage",
"licenseModifiedProvider",
"licenseReleaseDataTranslationCreated",
"licenseReleaseDataTranslationModifiedContentName",
"licenseReleaseDataTranslationModifiedContentValue",
"licenseReleaseDataTranslationModifiedLanguage",
"licenseReleaseTranslationCreated",
"licenseReleaseTranslationModifiedLanguage",
"licenseReleaseTranslationModifiedName",
"loginAttempted",
"messageCenterCreated",
"messageCenterDeleted",
"messageCenterModifiedCollectionsAdded",
"messageCenterModifiedCollectionsRemoved",
"messageCenterModifiedNotificationByApplication",
"messageCenterModifiedNotificationByEmail",
"messageCenterModifiedNotificationDayTime",
"messageCenterModifiedNotificationInterval",
"messageCenterModifiedNotificationMonthDay",
"messageCenterModifiedNotificationWeekDay",
"messageCenterModifiedNotifyCollectionDeleted",
"messageCenterModifiedNotifyCollectionEdited",
"messageCenterModifiedNotifyCollectionMessagingWithoutSubscription",
"messageCenterModifiedNotifyCollectionShared",
"messageCenterModifiedNotifyCollectionSharedInternalWithMe",
"messageCenterModifiedNotifyExternalSharedCollectionOpened",
"metadataFieldCreated",
"metadataFieldDeleted",
"metadataFieldModifiedEditType",
"metadataFieldModifiedIndexedForSearchTerm",
"metadataFieldModifiedIsImportant",
"metadataFieldModifiedIsSearchable",
"metadataFieldModifiedName",
"metadataFieldModifiedSelectionTermsAdded",
"metadataFieldModifiedSelectionTermsRemoved",
"metadataFieldModifiedSelectionTermsRenamed",
"modelCreated",
"modelDeleted",
"modelFileCreated",
"modelFileDeleted",
"modelFileModifiedColor",
"modelFileModifiedCreateDate",
"modelFileModifiedFile",
"modelFileModifiedName",
"modelFileModifiedShowFile",
"modelFileModifiedShowWarningMessage",
"modelFileModifiedWarningMessage",
"modelModifiedBirthDate",
"modelModifiedEmail",
"modelModifiedFirstName",
"modelModifiedLastName",
"modelReleaseTranslationCreated",
"modelReleaseTranslationModifiedLanguage",
"modelReleaseTranslationModifiedName",
"newFileCreated",
"permissionGroupCreated",
"permissionGroupDeleted",
"permissionGroupModifiedCommentFiles",
"permissionGroupModifiedCreateCollections",
"permissionGroupModifiedCreateDirectoriesInHomeDirectory",
"permissionGroupModifiedCreateKeywords",
"permissionGroupModifiedCreatePortals",
"permissionGroupModifiedCreateUploadLinks",
"permissionGroupModifiedDefaultUploadFileState",
"permissionGroupModifiedDeleteForeignCollections",
"permissionGroupModifiedDeleteForeignFiles",
"permissionGroupModifiedDeleteOwnCollections",
"permissionGroupModifiedDeleteOwnFiles",
"permissionGroupModifiedDirectoryIDsToEditAdded",
"permissionGroupModifiedDirectoryIDsToEditAll",
"permissionGroupModifiedDirectoryIDsToEditRemoved",
"permissionGroupModifiedDirectoryIDsToModifyAdded",
"permissionGroupModifiedDirectoryIDsToModifyAll",
"permissionGroupModifiedDirectoryIDsToModifyRemoved",
"permissionGroupModifiedDirectoryIDsToShowAdded",
"permissionGroupModifiedDirectoryIDsToShowAll",
"permissionGroupModifiedDirectoryIDsToShowRemoved",
"permissionGroupModifiedDirectoryIDsToUploadAdded",
"permissionGroupModifiedDirectoryIDsToUploadAll",
"permissionGroupModifiedDirectoryIDsToUploadRemoved",
"permissionGroupModifiedDownloadFormatIDsAdded",
"permissionGroupModifiedDownloadFormatIDsRemoved",
"permissionGroupModifiedEditDesign",
"permissionGroupModifiedEditFilesInHomeDirectory",
"permissionGroupModifiedEditFilesInInternalSharedCollections",
"permissionGroupModifiedEditForeignCollections",
"permissionGroupModifiedEditForeignFiles",
"permissionGroupModifiedEditLicenses",
"permissionGroupModifiedEditUsers",
"permissionGroupModifiedFileStatesToAssignAdded",
"permissionGroupModifiedFileStatesToAssignAll",
"permissionGroupModifiedFileStatesToAssignRemoved",
"permissionGroupModifiedFileStatesToShowAdded",
"permissionGroupModifiedFileStatesToShowAll",
"permissionGroupModifiedFileStatesToShowRemoved",
"permissionGroupModifiedForceDownloadProof",
"permissionGroupModifiedForceExportProof",
"permissionGroupModifiedForceWatermark",
"permissionGroupModifiedHasDownloadFormatFree",
"permissionGroupModifiedHasDownloadFormatOriginal",
"permissionGroupModifiedHasDownloadFormatPreview",
"permissionGroupModifiedIsAdmin",
"permissionGroupModifiedIsExternal",
"permissionGroupModifiedLinked",
"permissionGroupModifiedName",
"permissionGroupModifiedShareCollectionsExternal",
"permissionGroupModifiedShareCollectionsInternal",
"permissionGroupModifiedShareCollectionsNetwork",
"permissionGroupModifiedShareFilesNetwork",
"permissionGroupModifiedShowAllCustomDownloadFormats",
"permissionGroupModifiedUnlinked",
"permissionGroupModifiedUploadFilesToHomeDirectory",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsAdded",
"permissionGroupModifiedUploadMandatoryDefaultMetadataFieldsRemoved",
"permissionGroupModifiedUploadObligationsAdded",
"permissionGroupModifiedUploadObligationsRemoved",
"portalCollectionModifiedIsProtected",
"portalCollectionModifiedOrder",
"portalCreated",
"portalDeleted",
"portalModifiedActivateUserAutomatically",
"portalModifiedAddShadowToFont",
"portalModifiedAutomaticallyActivatedDomainsAdded",
"portalModifiedAutomaticallyActivatedDomainsRemoved",
"portalModifiedBackgroundColor",
"portalModifiedBrandURL",
"portalModifiedBrandingLogoImage",
"portalModifiedCollectionAssetNavigator",
"portalModifiedCollectionsAdded",
"portalModifiedCollectionsRemoved",
"portalModifiedCookieLinkPrivacyPage",
"portalModifiedCookiePlacement",
"portalModifiedCustomMetadataIDsAdded",
"portalModifiedCustomMetadataIDsRemoved",
"portalModifiedDefaultMetadataFieldsAdded",
"portalModifiedDefaultMetadataFieldsRemoved",
"portalModifiedDownloadFormatsAdded",
"portalModifiedDownloadFormatsRemoved",
"portalModifiedEmailReceiver",
"portalModifiedFilterOptionsAdded",
"portalModifiedFilterOptionsRemoved",
"portalModifiedForceDownloadProof",
"portalModifiedForceWatermark",
"portalModifiedGeneralPassword",
"portalModifiedHasUserRegistration",
"portalModifiedHasWhitelabel",
"portalModifiedHeroArrowColor",
"portalModifiedHeroBannerImage",
"portalModifiedHeroFontColor",
"portalModifiedHeroLogoColor",
"portalModifiedHeroLogoImage",
"portalModifiedHostNames",
"portalModifiedIsActive",
"portalModifiedLandingPageOptions",
"portalModifiedLanguagesAdded",
"portalModifiedLanguagesRemoved",
"portalModifiedLicenseReleaseIDsAdded",
"portalModifiedLicenseReleaseIDsRemoved",
"portalModifiedMainHostName",
"portalModifiedMediaViewsAdded",
"portalModifiedMediaViewsRemoved",
"portalModifiedModelReleaseIDsAdded",
"portalModifiedModelReleaseIDsRemoved",
"portalModifiedName",
"portalModifiedOriginalDownloadFormatTypesAdded",
"portalModifiedOriginalDownloadFormatTypesRemoved",
"portalModifiedPageName",
"portalModifiedPagePlacementsAdded",
"portalModifiedPagePlacementsRemoved",
"portalModifiedPageText",
"portalModifiedPageTranslationCreated",
"portalModifiedPageTranslationLanguage",
"portalModifiedPageTranslationName",
"portalModifiedPageTranslationText",
"portalModifiedPagesAdded",
"portalModifiedPagesRemoved",
"portalModifiedPreferredMode",
"portalModifiedPreferredTitle",
"portalModifiedPropertyReleaseIDsAdded",
"portalModifiedPropertyReleaseIDsRemoved",
"portalModifiedProtectedCollectionsAdded",
"portalModifiedProtectedCollectionsRemoved",
"portalModifiedRestrictAccess",
"portalModifiedSearchFieldsAdded",
"portalModifiedSearchFieldsRemoved",
"portalModifiedShowAllLicenseReleases",
"portalModifiedShowAllModelReleases",
"portalModifiedShowAllPropertyReleases",
"portalModifiedShowBorder",
"portalModifiedShowCookieInformation",
"portalModifiedShowCreateLinkToFileTab",
"portalModifiedShowFileType",
"portalModifiedShowLicenseReleaseFile",
"portalModifiedShowModelReleaseFile",
"portalModifiedShowPropertyReleaseFile",
"portalModifiedShowStartScreen",
"portalModifiedSortOptionsAdded",
"portalModifiedSortOptionsRemoved",
"portalModifiedStandardMetadataIDsAdded",
"portalModifiedStandardMetadataIDsRemoved",
"portalModifiedStartScreenText",
"portalModifiedTranslationCookieTextShort",
"portalModifiedTranslationFooterText",
"portalModifiedTranslationHeroSlogan",
"portalModifiedTranslationLanguage",
"portalModifiedUseSSO",
"portalModifiedUseSemanticSearch",
"portalModifiedUserCompany",
"portalModifiedUserDepartment",
"portalModifiedUserEmail",
"portalModifiedUserFirstName",
"portalModifiedUserIsActive",
"portalModifiedUserIsConfirmed",
"portalModifiedUserLanguage",
"portalModifiedUserLastName",
"portalModifiedUserPassword",
"portalModifiedUsersAdded",
"portalModifiedUsersRemoved",
"propertyCreated",
"propertyDeleted",
"propertyFileCreated",
"propertyFileDeleted",
"propertyFileModifiedColor",
"propertyFileModifiedCreateDate",
"propertyFileModifiedFile",
"propertyFileModifiedName",
"propertyFileModifiedShowFile",
"propertyFileModifiedShowWarningMessage",
"propertyFileModifiedWarningMessage",
"propertyModifiedAddress",
"propertyModifiedName",
"propertyModifiedOwner",
"propertyReleaseTranslationCreated",
"propertyReleaseTranslationModifiedLanguage",
"propertyReleaseTranslationModifiedName",
"reportCreated",
"reportDeleted",
"reportModifiedAdditionalText",
"reportModifiedDayInMonth",
"reportModifiedDayInWeek",
"reportModifiedDayTime",
"reportModifiedIsActive",
"reportModifiedName",
"reportModifiedReceiverEmailsAdded",
"reportModifiedReceiverEmailsRemoved",
"reportModifiedReportEventsAdded",
"reportModifiedReportEventsRemoved",
"reportModifiedReportEventsReplaced",
"reportModifiedReportInterval",
"reportModifiedReportWhenNoData",
"reportModifiedSendCSV",
"reportModifiedSendPDF",
"reportUpdated",
"settingsModifiedCustomJavaScript",
"settingsModifiedDateFormat",
"settingsModifiedExternalCollectionSyncHostName",
"settingsModifiedExternalCollectionSyncPassword",
"settingsModifiedExternalCollectionSyncUserName",
"settingsModifiedExternalCustomCss",
"settingsModifiedExternalShareHostName",
"settingsModifiedExternalSharePassword",
"settingsModifiedExternalShareUserName",
"settingsModifiedFaviconFile",
"settingsModifiedFaviconText",
"settingsModifiedFont",
"settingsModifiedLogoBigDark",
"settingsModifiedLogoBigLight",
"settingsModifiedLogoBootFile",
"settingsModifiedLogoDarkFile",
"settingsModifiedLogoFile",
"settingsModifiedLogoIconDark",
"settingsModifiedLogoIconLight",
"settingsModifiedLogoLink",
"settingsModifiedPrimaryColorDark",
"settingsModifiedPrimaryColorLight",
"settingsModifiedProxyHostName",
"settingsModifiedProxyPort",
"settingsModifiedSMTPHasSSL",
"settingsModifiedSMTPHostName",
"settingsModifiedSMTPPassword",
"settingsModifiedSMTPPort",
"settingsModifiedSMTPTransmitterEmail",
"settingsModifiedSMTPTransmitterName",
"settingsModifiedSMTPUseDefault",
"settingsModifiedSMTPUserName",
"settingsModifiedSecondaryColorDark",
"settingsModifiedSecondaryColorLight",
"settingsModifiedSloganStartscreen",
"settingsModifiedStartscreenFile",
"settingsModifiedUploadLinkBackgroundFile",
"settingsModifiedWatermarkFile",
"settingsModifiedWatermarkPositionIsBottomLeft",
"settingsModifiedWatermarkPositionIsBottomMiddle",
"settingsModifiedWatermarkPositionIsBottomRight",
"settingsModifiedWatermarkPositionIsCenter",
"settingsModifiedWatermarkPositionIsMiddleLeft",
"settingsModifiedWatermarkPositionIsMiddleRight",
"settingsModifiedWatermarkPositionIsUpperLeft",
"settingsModifiedWatermarkPositionIsUpperMiddle",
"settingsModifiedWatermarkPositionIsUpperRight",
"settingsModifiedWatermarkPositioningType",
"settingsModifiedWatermarkText",
"settingsModifiedWatermarkTransparency",
"settingsModifiedWatermarkWidthPercent",
"spaceCreated",
"spaceDeleted",
"spaceModifiedAutomaticallyActivatedDomainsAdded",
"spaceModifiedAutomaticallyActivatedDomainsRemoved",
"spaceModifiedCopyrightText",
"spaceModifiedCustomBodyFontFileID",
"spaceModifiedCustomHeadingsFontFileID",
"spaceModifiedCustomMetadataIDs",
"spaceModifiedCustomization",
"spaceModifiedDefaultMetadataFields",
"spaceModifiedDownloadFormatIDsAdded",
"spaceModifiedDownloadFormatIDsRemoved",
"spaceModifiedFaviconImage",
"spaceModifiedForceDownloadProof",
"spaceModifiedForceWatermark",
"spaceModifiedHostNames",
"spaceModifiedIsActive",
"spaceModifiedLanguagesAdded",
"spaceModifiedLanguagesRemoved",
"spaceModifiedLicenseReleaseIDs",
"spaceModifiedLoginBackgroundImage",
"spaceModifiedLoginHeadline",
"spaceModifiedLoginRequired",
"spaceModifiedLogoDarkImage",
"spaceModifiedLogoLightImage",
"spaceModifiedMainHostName",
"spaceModifiedModelReleaseIDs",
"spaceModifiedName",
"spaceModifiedNavigationFooter",
"spaceModifiedNavigationHeader",
"spaceModifiedOriginalDownloadFormatTypesAdded",
"spaceModifiedOriginalDownloadFormatTypesRemoved",
"spaceModifiedPermissionGroupIDsAdded",
"spaceModifiedPermissionGroupIDsRemoved",
"spaceModifiedPermissionGroupsAdded",
"spaceModifiedPermissionGroupsRemoved",
"spaceModifiedPreferredTitle",
"spaceModifiedPrimaryColor",
"spaceModifiedPropertyReleaseIDs",
"spaceModifiedSearchFieldsAdded",
"spaceModifiedSearchFieldsRemoved",
"spaceModifiedSecondaryColor",
"spaceModifiedShowAllLicenseReleases",
"spaceModifiedShowAllModelReleases",
"spaceModifiedShowAllPropertyReleases",
"spaceModifiedShowFileType",
"spaceModifiedShowLicenseReleaseFile",
"spaceModifiedShowModelReleaseFile",
"spaceModifiedShowPropertyReleaseFile",
"spaceModifiedShowTermsOfUse",
"spaceModifiedStandardMetadataIDs",
"spaceModifiedStartScreenPage",
"spaceModifiedTermsOfUse",
"spaceModifiedUseSSO",
"spaceModifiedUseSemanticSearch",
"spaceNavigationFooterCreated",
"spaceNavigationFooterDeleted",
"spaceNavigationFooterLinkCreated",
"spaceNavigationFooterLinkDeleted",
"spaceNavigationFooterLinkTranslationCreated",
"spaceNavigationFooterTranslationCreated",
"spaceNavigationHeaderCategoryCreated",
"spaceNavigationHeaderCategoryDeleted",
"spaceNavigationHeaderCategoryTranslationCreated",
"spaceNavigationHeaderCreated",
"spaceNavigationHeaderDeleted",
"spaceNavigationHeaderTranslationCreated",
"spaceNavigationModifiedAnchor",
"spaceNavigationModifiedFooterFooterText",
"spaceNavigationModifiedFooterLinkName",
"spaceNavigationModifiedFooterLinkOrder",
"spaceNavigationModifiedFooterName",
"spaceNavigationModifiedFooterOrder",
"spaceNavigationModifiedHeaderCategoryName",
"spaceNavigationModifiedHeaderCategoryOrder",
"spaceNavigationModifiedHeaderName",
"spaceNavigationModifiedHeaderOrder",
"spaceNavigationModifiedLink",
"spaceNavigationModifiedSpacePageID",
"spacePageCreated",
"spacePageDeleted",
"spacePageModifiedContent",
"spacePageModifiedName",
"spacePageModifiedSlug",
"spacePageTemplateCreated",
"spacePageTemplateDeleted",
"spacePageTemplateUpdated",
"spacePageTranslationCreated",
"spaceTemplateCreated",
"spaceTemplateDeleted",
"spaceTemplateUpdated",
"standardMetadataCreated",
"standardMetadataDeleted",
"standardMetadataModifiedValue",
"standardMetadataModifiedValueType",
"synonymColumnsModifiedSynonym1",
"synonymColumnsModifiedSynonym10",
"synonymColumnsModifiedSynonym11",
"synonymColumnsModifiedSynonym12",
"synonymColumnsModifiedSynonym13",
"synonymColumnsModifiedSynonym14",
"synonymColumnsModifiedSynonym15",
"synonymColumnsModifiedSynonym16",
"synonymColumnsModifiedSynonym17",
"synonymColumnsModifiedSynonym18",
"synonymColumnsModifiedSynonym19",
"synonymColumnsModifiedSynonym2",
"synonymColumnsModifiedSynonym20",
"synonymColumnsModifiedSynonym3",
"synonymColumnsModifiedSynonym4",
"synonymColumnsModifiedSynonym5",
"synonymColumnsModifiedSynonym6",
"synonymColumnsModifiedSynonym7",
"synonymColumnsModifiedSynonym8",
"synonymColumnsModifiedSynonym9",
"synonymCreated",
"synonymDeleted",
"synonymModifiedSynonym",
"tenantModifiedAdditionalDiskSpaceGigaByte",
"tenantModifiedCustomUnlockedFeatures",
"tenantModifiedCustomUnlockedFeaturesAdded",
"tenantModifiedCustomUnlockedFeaturesRemoved",
"tenantModifiedExpirationDate",
"tenantModifiedMediaPortalLimit",
"tenantModifiedPackageIdentifier",
"tenantModifiedReadOnlyUserLimit",
"tenantModifiedUserLimit",
"trashCreated",
"trashDeleted",
"trashFileIDsRestored",
"uploadLinkCreated",
"uploadLinkDeleted",
"uploadLinkFileUploaded",
"uploadLinkModifiedDescription",
"uploadLinkModifiedDirectoryID",
"uploadLinkModifiedEmailsAdded",
"uploadLinkModifiedFaceRecognitionDisabled",
"uploadLinkModifiedFileStateID",
"uploadLinkModifiedFilesAdded",
"uploadLinkModifiedFilesRemoved",
"uploadLinkModifiedIsDisabled",
"uploadLinkModifiedKeywordsAdded",
"uploadLinkModifiedKeywordsRemoved",
"uploadLinkModifiedLicenseReleaseIDsAdded",
"uploadLinkModifiedLicenseReleaseIDsRemoved",
"uploadLinkModifiedModelReleaseIDsAdded",
"uploadLinkModifiedModelReleaseIDsRemoved",
"uploadLinkModifiedName",
"uploadLinkModifiedNotificationText",
"uploadLinkModifiedPropertyReleaseIDsAdded",
"uploadLinkModifiedPropertyReleaseIDsRemoved",
"uploadLinkModifiedShowAllLicenseReleases",
"uploadLinkModifiedShowAllModelReleases",
"uploadLinkModifiedShowAllPropertyReleases",
"uploadLinkModifiedUploadCondition",
"uploadLinkModifiedUserID",
"uploadLinkModifiedValidityPeriod",
"userCreated",
"userDeleted",
"userModifiedCIFSPassword",
"userModifiedEmail",
"userModifiedFirstName",
"userModifiedIsActive",
"userModifiedIsExternal",
"userModifiedLanguage",
"userModifiedLastName",
"userModifiedLinked",
"userModifiedPassword",
"userModifiedPermissionGroupIDsAdded",
"userModifiedPermissionGroupIDsRemoved",
"userModifiedRefreshToken",
"userModifiedResetPasswordStamp",
"userModifiedResetPasswordToken",
"userModifiedSecret",
"userModifiedSecretExpirationDate",
"userModifiedTwoFactorAuthSetUp",
"userModifiedUnlinked",
"userModifiedUserName",
"userTrackingCreated",
"userTrackingDeleted",
"userTrackingModifiedFirstMonthlyLogin",
"userTrackingModifiedUserID",
"variantStackCreated",
"variantStackDeleted",
"variantStackModifiedDescription",
"variantStackModifiedFilesAdded",
"variantStackModifiedFilesRemoved",
"variantStackModifiedName",
"webhookCreated",
"webhookDeleted",
"webhookModifiedDescription",
"webhookModifiedEventKey",
"webhookModifiedEventKeysAdded",
"webhookModifiedEventKeysRemoved",
"webhookModifiedName",
"webhookModifiedSecret",
"webhookModifiedURL"
],
"example": "fileCreated",
"title": "EventKeyOnlyApplication",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"resourceID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"resourceName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"resourceOwnerUserID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"resourceOwnerUserName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"resourceOwnerUserType": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
},
"resourceType": {
"description": "The type of the resource that was affected by the event",
"enum": [
"apiKey",
"assetNavigator",
"assetNavigatorCategory",
"azureActiveDirectory",
"collection",
"comment",
"customMetadata",
"customMetadataLanguages",
"customMetadataOptionLanguages",
"customMetadataOptions",
"directLink",
"directory",
"download",
"downloadFormat",
"duplicateFile",
"emailCustomTemplate",
"externalShare",
"externalSharedCollection",
"externalSharesComment",
"externalSharesUpvote",
"file",
"fileState",
"filesCustomField",
"filter",
"generalSettings",
"identityProvider",
"importantMetadata",
"internalMetadata",
"keyword",
"license",
"licenseFile",
"login",
"manageAdministrationServer",
"manageBatchTenant",
"manageFeature",
"manageHost",
"managePackage",
"managePackagePortal",
"managePlugin",
"manageServer",
"manageSystem",
"manageUnlockedPlugin",
"messageCenter",
"metadataField",
"model",
"modelFile",
"newFile",
"permissionGroup",
"portal",
"portalAssetNavigator",
"portalCollection",
"property",
"propertyFile",
"report",
"settings",
"space",
"spaceNavigation",
"spacePage",
"spacePageTemplate",
"spaceTemplate",
"standardMetadata",
"synonym",
"synonymColumns",
"tenant",
"trash",
"uploadLink",
"user",
"userTracking",
"variantStack",
"webhook"
],
"example": "file",
"title": "EventResourceType",
"type": "string"
},
"userDescriptiveName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"userID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"userName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"userType": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
}
},
"title": "EventOnlyApplication",
"type": "object"
},
"ExternalShare": {
"properties": {
"allowComments": {
"type": "boolean"
},
"allowDownloads": {
"type": "boolean"
},
"allowUpvotes": {
"type": "boolean"
},
"collection": {
"$ref": "#/components/schemas/CollectionBasic"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"downloadFormats": {
"items": {
"$ref": "#/components/schemas/DownloadFormatBasic"
},
"type": "array"
},
"emails": {
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"type": "array"
},
"expirationDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"exportProof": {
"type": "string"
},
"fileDetails": {
"items": {
"description": "The type of the FileDetail",
"enum": [
"basicMetadata",
"importantMetadata",
"licenseInfo",
"unimportantMetadata"
],
"example": "unimportantMetadata",
"title": "FileDetail",
"type": "string"
},
"type": "array"
},
"filesQuantity": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"forceDownloadProof": {
"type": "boolean"
},
"forceWatermark": {
"type": "boolean"
},
"hasDownloadFormatFree": {
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"type": "boolean"
},
"hasDownloadFormatPreview": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"isDisabled": {
"type": "boolean"
},
"lastOpenedDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"mediaViews": {
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"noAds": {
"type": "boolean"
},
"notificationText": {
"type": "string"
},
"numberOfComments": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"numberOfDownloads": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"numberOfUpvotes": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"openedCounter": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"password": {
"description": "An encrypted password.",
"example": "censored",
"title": "EncryptedPassword",
"type": "string"
},
"securedWithPassword": {
"type": "boolean"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"termsOfUse": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"validityPeriod": {
"description": "The validity period of the external share.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"title": "ExternalShare",
"type": "object"
},
"ExternalShareCommentCreated": {
"properties": {
"externalShareID": {
"description": "The externalShareID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"fileID": {
"description": "The fileID of the commented file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "ExternalShareCommentCreated",
"type": "object"
},
"ExternalShareCommentDeleted": {
"properties": {
"externalShareID": {
"description": "The externalShareID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"fileID": {
"description": "The fileID of the commented file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "ExternalShareCommentDeleted",
"type": "object"
},
"ExternalShareModifiedAllowComments": {
"properties": {
"newAllowComments": {
"description": "The new allowComments.",
"type": "boolean"
},
"oldAllowComments": {
"description": "The old allowComments.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedAllowComments",
"type": "object"
},
"ExternalShareModifiedAllowDownloads": {
"properties": {
"newAllowDownloads": {
"description": "The new allowDownloads.",
"type": "boolean"
},
"oldAllowDownloads": {
"description": "The old allowDownloads.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedAllowDownloads",
"type": "object"
},
"ExternalShareModifiedAllowUpvotes": {
"properties": {
"newAllowUpvotes": {
"description": "The new allowUpvotes.",
"type": "boolean"
},
"oldAllowUpvotes": {
"description": "The old allowUpvotes.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedAllowUpvotes",
"type": "object"
},
"ExternalShareModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "ExternalShareModifiedDescription",
"type": "object"
},
"ExternalShareModifiedDownloadFormatsAdded": {
"properties": {
"downloadFormatsAdded": {
"$ref": "#/components/schemas/ArraySchema_3464386466"
}
},
"title": "ExternalShareModifiedDownloadFormatsAdded",
"type": "object"
},
"ExternalShareModifiedDownloadFormatsRemoved": {
"properties": {
"downloadFormatsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3434343239"
}
},
"title": "ExternalShareModifiedDownloadFormatsRemoved",
"type": "object"
},
"ExternalShareModifiedEmailsAdded": {
"properties": {
"emailsAdded": {
"$ref": "#/components/schemas/ArraySchema_6662666538"
}
},
"title": "ExternalShareModifiedEmailsAdded",
"type": "object"
},
"ExternalShareModifiedFileDetailsAdded": {
"properties": {
"fileDetailsAdded": {
"$ref": "#/components/schemas/ArraySchema_6230313933"
}
},
"title": "ExternalShareModifiedFileDetailsAdded",
"type": "object"
},
"ExternalShareModifiedFileDetailsRemoved": {
"properties": {
"fileDetailsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6331643262"
}
},
"title": "ExternalShareModifiedFileDetailsRemoved",
"type": "object"
},
"ExternalShareModifiedFilesAdded": {
"properties": {
"filesAdded": {
"$ref": "#/components/schemas/ArraySchema_3131366263"
}
},
"title": "ExternalShareModifiedFilesAdded",
"type": "object"
},
"ExternalShareModifiedFilesRemoved": {
"properties": {
"filesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3766376639"
}
},
"title": "ExternalShareModifiedFilesRemoved",
"type": "object"
},
"ExternalShareModifiedForceDownloadProof": {
"properties": {
"newForceDownloadProof": {
"description": "The new forceDownloadProof-flag.",
"type": "boolean"
},
"oldForceDownloadProof": {
"description": "The old forceDownloadProof-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedForceDownloadProof",
"type": "object"
},
"ExternalShareModifiedForceWatermark": {
"properties": {
"newForceWatermark": {
"description": "The new forceWatermark-flag.",
"type": "boolean"
},
"oldForceWatermark": {
"description": "The old forceWatermark-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedForceWatermark",
"type": "object"
},
"ExternalShareModifiedHasDownloadFormatFree": {
"properties": {
"newHasDownloadFormatFree": {
"description": "The new hasDownloadFormatFree-flag.",
"type": "boolean"
},
"oldHasDownloadFormatFree": {
"description": "The old hasDownloadFormatFree-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedHasDownloadFormatFree",
"type": "object"
},
"ExternalShareModifiedHasDownloadFormatOriginal": {
"properties": {
"newHasDownloadFormatOriginal": {
"description": "The new hasDownloadFormatOriginal-flag.",
"type": "boolean"
},
"oldHasDownloadFormatOriginal": {
"description": "The old hasDownloadFormatOriginal-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedHasDownloadFormatOriginal",
"type": "object"
},
"ExternalShareModifiedHasDownloadFormatPreview": {
"properties": {
"newHasDownloadFormatPreview": {
"description": "The new hasDownloadFormatPreview-flag.",
"type": "boolean"
},
"oldHasDownloadFormatPreview": {
"description": "The old hasDownloadFormatPreview-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedHasDownloadFormatPreview",
"type": "object"
},
"ExternalShareModifiedIsDisabled": {
"properties": {
"newIsDisabled": {
"description": "The new isDisabled-flag.",
"type": "boolean"
},
"oldIsDisabled": {
"description": "The old isDisabled-flag.",
"type": "boolean"
}
},
"title": "ExternalShareModifiedIsDisabled",
"type": "object"
},
"ExternalShareModifiedMediaViewsAdded": {
"properties": {
"mediaViewsAdded": {
"$ref": "#/components/schemas/ArraySchema_3530643134"
}
},
"title": "ExternalShareModifiedMediaViewsAdded",
"type": "object"
},
"ExternalShareModifiedMediaViewsRemoved": {
"properties": {
"mediaViewsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6436316532"
}
},
"title": "ExternalShareModifiedMediaViewsRemoved",
"type": "object"
},
"ExternalShareModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ExternalShareModifiedName",
"type": "object"
},
"ExternalShareModifiedNotificationText": {
"properties": {
"newNotificationText": {
"description": "The new notificationText.",
"type": "string"
},
"oldNotificationText": {
"description": "The old notificationText.",
"type": "string"
}
},
"title": "ExternalShareModifiedNotificationText",
"type": "object"
},
"ExternalShareModifiedTermsOfUse": {
"properties": {
"newTermsOfUse": {
"description": "The new termsOfUse.",
"type": "string"
},
"oldTermsOfUse": {
"description": "The old termsOfUse.",
"type": "string"
}
},
"title": "ExternalShareModifiedTermsOfUse",
"type": "object"
},
"ExternalShareModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "ExternalShareModifiedUserID",
"type": "object"
},
"ExternalShareModifiedValidityPeriod": {
"properties": {
"newValidityPeriod": {
"description": "The new validityPeriod.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
},
"oldValidityPeriod": {
"description": "The old validityPeriod.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"title": "ExternalShareModifiedValidityPeriod",
"type": "object"
},
"ExternalShareUpvoteCreated": {
"properties": {
"externalShareID": {
"description": "The externalShareID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"fileID": {
"description": "The fileID of the upvoted file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "ExternalShareUpvoteCreated",
"type": "object"
},
"ExternalShareUpvoteDeleted": {
"properties": {
"externalShareID": {
"description": "The externalShareID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"fileID": {
"description": "The fileID of the upvoted file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "ExternalShareUpvoteDeleted",
"type": "object"
},
"Face": {
"description": "A face detected in an image or video.",
"example": {
"boundingBox": {
"height": 100.46,
"left": 50.5,
"top": 50.5,
"width": 100.5
},
"id": 123,
"isIgnored": false,
"isManual": false,
"person": {
"description": "The person John Doe.",
"firstName": "John",
"id": 456,
"lastName": "Doe"
}
},
"properties": {
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isIgnored": {
"type": "boolean"
},
"isManual": {
"type": "boolean"
},
"person": {
"$ref": "#/components/schemas/Person"
}
},
"title": "Face",
"type": "object"
},
"File": {
"properties": {
"allowDirectLinks": {
"$ref": "#/components/schemas/AllowDirectLinks"
},
"clipFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"colorspace": {
"description": "The colorspace of a media file.",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"creator": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"description": {
"type": "string"
},
"directory": {
"$ref": "#/components/schemas/DirectoryBasic"
},
"dominantColor": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"externalShareNumberOfComments": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"externalShareNumberOfDownloads": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"externalShareNumberOfUpvotes": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"faceRecognitionDisabled": {
"type": "boolean"
},
"faces": {
"items": {
"$ref": "#/components/schemas/Face"
},
"type": "array"
},
"fileExtension": {
"description": "NormalizedFileExtension is an Entity for a NormalizedFileExtension. Control Characters at the beginning and end of the name are removed. Control Characters inside the NormalizedFileExtension are replaced by one whitespace.",
"example": "JPG",
"title": "NormalizedFileExtension",
"type": "string"
},
"fileName": {
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"fileState": {
"$ref": "#/components/schemas/FileStateBasic"
},
"fileType": {
"description": "FileType is an Entity for a FileType. The FileType is determined by the aspect ratio of the file.",
"enum": [
"audio",
"image",
"video"
],
"example": "image",
"title": "FileType",
"type": "string"
},
"hasPreviewPlaceholder": {
"type": "boolean"
},
"hasSubversions": {
"description": "The file has subversions when it is the selected currently-visible file from a version-stack",
"type": "boolean"
},
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"importantMetadata": {
"items": {
"$ref": "#/components/schemas/Metadata"
},
"type": "array"
},
"isArchived": {
"description": "The file is archived when it was assigned to an archive file-state.",
"type": "boolean"
},
"isCheckedOut": {
"type": "boolean"
},
"isConvertible": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isDownloadLocked": {
"type": "boolean"
},
"isMainVersion": {
"description": "\u003cp\u003eThe file is a main version when:\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003ethe file is not part of a version-stack\u003c/p\u003e\n\u003cp\u003ethe file is the selected currently-visible file from a version-stack\u003c/p\u003e \u003c/blockquote\u003e ",
"type": "boolean"
},
"isMarked": {
"type": "boolean"
},
"isRotatable": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"keywords": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"keywordsRecognition": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"languageCodes": {
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseForFile"
},
"type": "array"
},
"location": {
"$ref": "#/components/schemas/LocationForFile"
},
"mainVersion": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"md5sum": {
"description": "The MD5 hash of the file.",
"example": "d41d8cd98f00b204e9800998ecf8427e",
"title": "MD5Hash",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"metadataFields": {
"additionalProperties": {
"$ref": "#/components/schemas/MetadataFieldForFile"
},
"type": "object"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseForFile"
},
"type": "array"
},
"modifiedPreviewFileURLs": {
"items": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"orientation": {
"description": "Orientation is an Entity for a Orientation. The Orientation is determined by the aspect ratio of the file.",
"enum": [
"landscape",
"portrait",
"square",
"widescreen"
],
"example": "portrait",
"title": "Orientation",
"type": "string"
},
"originalFileURL": {
"deprecated": true,
"description": "An URL.\u003cbr\u003e**Caution:** deprecated, do not use!",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForFile"
},
"pixel": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"previewFileHeight": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"previewFileIsReplaced": {
"type": "boolean"
},
"previewFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"previewFileWidth": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseForFile"
},
"type": "array"
},
"rating": {
"description": "The rating of the file.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
},
"recognizedText": {
"items": {
"$ref": "#/components/schemas/RecognizedText"
},
"type": "array"
},
"rotation": {
"description": "\u003cp\u003eThe rotation of the file specified in pixx.io. This attribute does not store information about the rotation of the original file.\u003c/p\u003e ",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"staticCollections": {
"items": {
"$ref": "#/components/schemas/CollectionBasic"
},
"type": "array"
},
"subject": {
"type": "string"
},
"unimportantMetadata": {
"items": {
"$ref": "#/components/schemas/Metadata"
},
"type": "array"
},
"uploadDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"uploadLinkGuestUserEmail": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"uploadLinkGuestUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"uploadLinkID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"usePanoramaViewer": {
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/UserBasic_3765633131"
},
"variantStack": {
"$ref": "#/components/schemas/VariantStackBasic"
},
"variantStackLinkName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"versions": {
"$ref": "#/components/schemas/VersionsForFile"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "File",
"type": "object"
},
"FileBasic": {
"properties": {
"allowDirectLinks": {
"$ref": "#/components/schemas/AllowDirectLinks"
},
"clipFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"colorspace": {
"description": "The colorspace of a media file.",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"description": {
"type": "string"
},
"dominantColor": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"faces": {
"items": {
"$ref": "#/components/schemas/Face"
},
"type": "array"
},
"fileExtension": {
"description": "NormalizedFileExtension is an Entity for a NormalizedFileExtension. Control Characters at the beginning and end of the name are removed. Control Characters inside the NormalizedFileExtension are replaced by one whitespace.",
"example": "JPG",
"title": "NormalizedFileExtension",
"type": "string"
},
"fileName": {
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"fileType": {
"description": "FileType is an Entity for a FileType. The FileType is determined by the aspect ratio of the file.",
"enum": [
"audio",
"image",
"video"
],
"example": "image",
"title": "FileType",
"type": "string"
},
"hasPreviewPlaceholder": {
"type": "boolean"
},
"hasSubversions": {
"description": "The file has subversions when it is the selected currently-visible file from a version-stack",
"type": "boolean"
},
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isArchived": {
"description": "The file is archived when it was assigned to an archive file-state.",
"type": "boolean"
},
"isCheckedOut": {
"type": "boolean"
},
"isConvertible": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isDownloadLocked": {
"type": "boolean"
},
"isMainVersion": {
"description": "\u003cp\u003eThe file is a main version when:\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003ethe file is not part of a version-stack\u003c/p\u003e\n\u003cp\u003ethe file is the selected currently-visible file from a version-stack\u003c/p\u003e \u003c/blockquote\u003e ",
"type": "boolean"
},
"isMarked": {
"type": "boolean"
},
"isRotatable": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"keywords": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"keywordsRecognition": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"languageCodes": {
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseForFile"
},
"type": "array"
},
"location": {
"$ref": "#/components/schemas/LocationForFile"
},
"mainVersion": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"md5sum": {
"description": "The MD5 hash of the file.",
"example": "d41d8cd98f00b204e9800998ecf8427e",
"title": "MD5Hash",
"type": "string"
},
"metadataFields": {
"additionalProperties": {
"$ref": "#/components/schemas/MetadataFieldForFile"
},
"type": "object"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseForFile"
},
"type": "array"
},
"modifiedPreviewFileURLs": {
"items": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"type": "array"
},
"orientation": {
"description": "Orientation is an Entity for a Orientation. The Orientation is determined by the aspect ratio of the file.",
"enum": [
"landscape",
"portrait",
"square",
"widescreen"
],
"example": "portrait",
"title": "Orientation",
"type": "string"
},
"originalFileURL": {
"deprecated": true,
"description": "An URL.\u003cbr\u003e**Caution:** deprecated, do not use!",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"pixel": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"previewFileHeight": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"previewFileIsReplaced": {
"type": "boolean"
},
"previewFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"previewFileWidth": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseForFile"
},
"type": "array"
},
"rating": {
"description": "The rating of the file.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
},
"recognizedText": {
"items": {
"$ref": "#/components/schemas/RecognizedText"
},
"type": "array"
},
"rotation": {
"description": "\u003cp\u003eThe rotation of the file specified in pixx.io. This attribute does not store information about the rotation of the original file.\u003c/p\u003e ",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"subject": {
"type": "string"
},
"usePanoramaViewer": {
"type": "boolean"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FileBasic",
"type": "object"
},
"FileCreated": {
"properties": {
"directoryPath": {
"description": "The directoryIDPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"originalFileServerName": {
"description": "The original fileServerName.",
"example": "TIEhL2yrlp3VlamtF4__1622453439_3460058.jpg",
"title": "FileServerName",
"type": "string"
}
},
"title": "FileCreated",
"type": "object"
},
"FileCustomFieldModifiedValue": {
"properties": {
"id": {
"description": "The ID of the modified value.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newValue": {
"description": "The new value.",
"type": "object"
},
"oldValue": {
"description": "The old value.",
"type": "object"
}
},
"title": "FileCustomFieldModifiedValue",
"type": "object"
},
"FileCustomFieldModifiedValueCustomFieldsOptionID": {
"properties": {
"newValueCustomFieldsOptionID": {
"description": "The new ValueCustomFieldsOptionID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldValueCustomFieldsOptionID": {
"description": "The old ValueCustomFieldsOptionID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FileCustomFieldModifiedValueCustomFieldsOptionID",
"type": "object"
},
"FileCustomFieldModifiedValueCustomFieldsOptionIDs": {
"properties": {
"newValueCustomFieldsOptionIDs": {
"$ref": "#/components/schemas/ArraySchema_3438306535"
},
"oldValueCustomFieldsOptionIDs": {
"$ref": "#/components/schemas/ArraySchema_3434363736"
}
},
"title": "FileCustomFieldModifiedValueCustomFieldsOptionIDs",
"type": "object"
},
"FileDeleted": {
"properties": {
"originalFileServerName": {
"description": "The original fileServerName.",
"example": "TIEhL2yrlp3VlamtF4__1622453439_3460058.jpg",
"title": "FileServerName",
"type": "string"
}
},
"title": "FileDeleted",
"type": "object"
},
"FileDeletedDuplicate": {
"properties": {
"duplicateFileID": {
"description": "The ID of the duplicate file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FileDeletedDuplicate",
"type": "object"
},
"FileDownloaded": {
"properties": {
"downloadInfo": {
"$ref": "#/components/schemas/DownloadInfo"
}
},
"title": "FileDownloaded",
"type": "object"
},
"FileInfo": {
"example": {
"id": 1,
"name": "file.jpg"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileInfo",
"type": "object"
},
"FileInfo_6434383135": {
"description": "The new file.",
"example": {
"id": 1,
"name": "file.jpg"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileInfo",
"type": "object"
},
"FileInfo_6535353066": {
"description": "The old file.",
"example": {
"id": 1,
"name": "file.jpg"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileInfo",
"type": "object"
},
"FileModifiedCollectionIDsAdded": {
"properties": {
"collectionIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6463623432"
}
},
"title": "FileModifiedCollectionIDsAdded",
"type": "object"
},
"FileModifiedCollectionIDsRemoved": {
"properties": {
"collectionIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6236383334"
}
},
"title": "FileModifiedCollectionIDsRemoved",
"type": "object"
},
"FileModifiedCreateDate": {
"properties": {
"newCreateDate": {
"description": "The new createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldCreateDate": {
"description": "The old createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "FileModifiedCreateDate",
"type": "object"
},
"FileModifiedCreator": {
"properties": {
"newCreator": {
"description": "The new creator.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldCreator": {
"description": "The old creator.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedCreator",
"type": "object"
},
"FileModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "FileModifiedDescription",
"type": "object"
},
"FileModifiedDirectoryIDPath": {
"properties": {
"newDirectoryIDPath": {
"description": "The new directoryIDPath.",
"example": "/12/23/34/",
"title": "DirectoryIDPath",
"type": "string"
},
"newDirectoryPath": {
"description": "The new directoryPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"oldDirectoryIDPath": {
"description": "The old directoryIDPath.",
"example": "/12/23/34/",
"title": "DirectoryIDPath",
"type": "string"
},
"oldDirectoryPath": {
"description": "The old directoryPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
}
},
"title": "FileModifiedDirectoryIDPath",
"type": "object"
},
"FileModifiedExternalShareIDsAdded": {
"properties": {
"externalShareIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3430336163"
}
},
"title": "FileModifiedExternalShareIDsAdded",
"type": "object"
},
"FileModifiedExternalShareIDsRemoved": {
"properties": {
"externalShareIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3534653430"
}
},
"title": "FileModifiedExternalShareIDsRemoved",
"type": "object"
},
"FileModifiedFileName": {
"properties": {
"newFileName": {
"description": "The new fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"oldFileName": {
"description": "The old fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileModifiedFileName",
"type": "object"
},
"FileModifiedFileStateID": {
"properties": {
"newFileStateID": {
"description": "The new fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldFileStateID": {
"description": "The old fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FileModifiedFileStateID",
"type": "object"
},
"FileModifiedIsCheckedOut": {
"properties": {
"newIsCheckedOut": {
"description": "The new isCheckedOut.-flag.",
"type": "boolean"
},
"oldIsCheckedOut": {
"description": "The old isCheckedOut-flag.",
"type": "boolean"
}
},
"title": "FileModifiedIsCheckedOut",
"type": "object"
},
"FileModifiedIsDownloadLocked": {
"properties": {
"newIsDownloadLocked": {
"description": "The new isDownloadLocked-flag.",
"type": "boolean"
},
"oldIsDownloadLocked": {
"description": "The old isDownloadLocked-flag.",
"type": "boolean"
}
},
"title": "FileModifiedIsDownloadLocked",
"type": "object"
},
"FileModifiedKeywordsAdded": {
"properties": {
"keywordsAdded": {
"$ref": "#/components/schemas/ArraySchema_6233343262"
}
},
"title": "FileModifiedKeywordsAdded",
"type": "object"
},
"FileModifiedKeywordsDeleted": {
"properties": {
"keywordsDeleted": {
"$ref": "#/components/schemas/ArraySchema_3833663633"
}
},
"title": "FileModifiedKeywordsDeleted",
"type": "object"
},
"FileModifiedKeywordsRecognitionAdded": {
"properties": {
"keywordsRecognitionAdded": {
"$ref": "#/components/schemas/ArraySchema_3637333961"
}
},
"title": "FileModifiedKeywordsRecognitionAdded",
"type": "object"
},
"FileModifiedKeywordsRecognitionDeleted": {
"properties": {
"keywordsRecognitionDeleted": {
"$ref": "#/components/schemas/ArraySchema_3236323463"
}
},
"title": "FileModifiedKeywordsRecognitionDeleted",
"type": "object"
},
"FileModifiedLanguageCodesAdded": {
"properties": {
"languageCodesAdded": {
"$ref": "#/components/schemas/ArraySchema_3765383666"
}
},
"title": "FileModifiedLanguageCodesAdded",
"type": "object"
},
"FileModifiedLanguageCodesRemoved": {
"properties": {
"languageCodesRemoved": {
"$ref": "#/components/schemas/ArraySchema_6634353630"
}
},
"title": "FileModifiedLanguageCodesRemoved",
"type": "object"
},
"FileModifiedLicenseFilesAdded": {
"properties": {
"licenseFilesAdded": {
"$ref": "#/components/schemas/ArraySchema_3661663934"
}
},
"title": "FileModifiedLicenseFilesAdded",
"type": "object"
},
"FileModifiedLicenseFilesDeleted": {
"properties": {
"licenseFilesDeleted": {
"$ref": "#/components/schemas/ArraySchema_3730383333"
}
},
"title": "FileModifiedLicenseFilesDeleted",
"type": "object"
},
"FileModifiedLocation": {
"properties": {
"newLocation": {
"$ref": "#/components/schemas/Location_3962616263"
},
"oldLocation": {
"$ref": "#/components/schemas/Location_3739346466"
}
},
"title": "FileModifiedLocation",
"type": "object"
},
"FileModifiedMainVersionFileID": {
"properties": {
"newMainVersionFileID": {
"description": "The new mainVersionFileID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newMainVersionFileName": {
"description": "The new mainVersionFileName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldMainVersionFileID": {
"description": "The old mainVersionFileID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldMainVersionFileName": {
"description": "The old mainVersionFileName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedMainVersionFileID",
"type": "object"
},
"FileModifiedMarkedUserIDsAdded": {
"properties": {
"markedUserIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6565363231"
}
},
"title": "FileModifiedMarkedUserIDsAdded",
"type": "object"
},
"FileModifiedMarkedUserIDsRemoved": {
"properties": {
"markedUserIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6465653837"
}
},
"title": "FileModifiedMarkedUserIDsRemoved",
"type": "object"
},
"FileModifiedMetadataFieldDate": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newDate": {
"description": "The new metadataFieldDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldDate": {
"description": "The old metadataFieldDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldDate",
"type": "object"
},
"FileModifiedMetadataFieldFocalPoint": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newFocalPoint": {
"$ref": "#/components/schemas/FocalPoint_3566613430"
},
"oldFocalPoint": {
"$ref": "#/components/schemas/FocalPoint"
}
},
"title": "FileModifiedMetadataFieldFocalPoint",
"type": "object"
},
"FileModifiedMetadataFieldLanguagesAdded": {
"properties": {
"languagesAdded": {
"$ref": "#/components/schemas/ArraySchema_3633656531"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldLanguagesAdded",
"type": "object"
},
"FileModifiedMetadataFieldLanguagesDeleted": {
"properties": {
"languagesDeleted": {
"$ref": "#/components/schemas/ArraySchema_3330303934"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldLanguagesDeleted",
"type": "object"
},
"FileModifiedMetadataFieldLocation": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newLocation": {
"$ref": "#/components/schemas/Location_3537306532"
},
"oldLocation": {
"$ref": "#/components/schemas/Location_3064313965"
}
},
"title": "FileModifiedMetadataFieldLocation",
"type": "object"
},
"FileModifiedMetadataFieldMultiSelectionsAdded": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"multiSelectionsAdded": {
"$ref": "#/components/schemas/ArraySchema_6338623563"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldMultiSelectionsAdded",
"type": "object"
},
"FileModifiedMetadataFieldMultiSelectionsDeleted": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"multiSelectionsDeleted": {
"$ref": "#/components/schemas/ArraySchema_3337663130"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldMultiSelectionsDeleted",
"type": "object"
},
"FileModifiedMetadataFieldOrientation": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newRotation": {
"description": "The new metadataFieldOrientation.",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"oldRotation": {
"description": "The old metadataFieldOrientation.",
"example": 90,
"title": "Rotation",
"type": "integer"
}
},
"title": "FileModifiedMetadataFieldOrientation",
"type": "object"
},
"FileModifiedMetadataFieldSelection": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newSelection": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption"
},
"oldSelection": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3561656530"
}
},
"title": "FileModifiedMetadataFieldSelection",
"type": "object"
},
"FileModifiedMetadataFieldText": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newText": {
"description": "The new metadataFieldText.",
"type": "string"
},
"oldText": {
"description": "The old metadataFieldText.",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldText",
"type": "object"
},
"FileModifiedMetadataFieldTruncate": {
"properties": {
"id": {
"description": "The ID of the metadataField.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the metadataField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldData": {
"description": "The old data.",
"type": "string"
}
},
"title": "FileModifiedMetadataFieldTruncate",
"type": "object"
},
"FileModifiedModelFilesAdded": {
"properties": {
"modelFilesAdded": {
"$ref": "#/components/schemas/ArraySchema_3133323865"
}
},
"title": "FileModifiedModelFilesAdded",
"type": "object"
},
"FileModifiedModelFilesDeleted": {
"properties": {
"modelFilesDeleted": {
"$ref": "#/components/schemas/ArraySchema_3932353034"
}
},
"title": "FileModifiedModelFilesDeleted",
"type": "object"
},
"FileModifiedPropertyFilesAdded": {
"properties": {
"propertyFilesAdded": {
"$ref": "#/components/schemas/ArraySchema_6530316332"
}
},
"title": "FileModifiedPropertyFilesAdded",
"type": "object"
},
"FileModifiedPropertyFilesDeleted": {
"properties": {
"propertyFilesDeleted": {
"$ref": "#/components/schemas/ArraySchema_6162343139"
}
},
"title": "FileModifiedPropertyFilesDeleted",
"type": "object"
},
"FileModifiedRating": {
"properties": {
"newRating": {
"description": "The new rating.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
},
"oldRating": {
"description": "The old rating.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
}
},
"title": "FileModifiedRating",
"type": "object"
},
"FileModifiedRotation": {
"properties": {
"newRotation": {
"description": "The new rotation.",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"oldRotation": {
"description": "The old rotation.",
"example": 90,
"title": "Rotation",
"type": "integer"
}
},
"title": "FileModifiedRotation",
"type": "object"
},
"FileModifiedSubject": {
"properties": {
"newSubject": {
"description": "The new subject.",
"type": "string"
},
"oldSubject": {
"description": "The old subject.",
"type": "string"
}
},
"title": "FileModifiedSubject",
"type": "object"
},
"FileModifiedUploadDate": {
"properties": {
"newUploadDate": {
"description": "The new uploadDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldUploadDate": {
"description": "The old uploadDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "FileModifiedUploadDate",
"type": "object"
},
"FileModifiedUploadLink": {
"properties": {
"newUploadLink": {
"$ref": "#/components/schemas/UploadLinkInfo"
},
"oldUploadLink": {
"$ref": "#/components/schemas/UploadLinkInfo_3863373266"
}
},
"title": "FileModifiedUploadLink",
"type": "object"
},
"FileModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newUserName": {
"description": "The new userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserName": {
"description": "The old userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "FileModifiedUserID",
"type": "object"
},
"FileModifiedVariantStack": {
"properties": {
"newVariantStack": {
"$ref": "#/components/schemas/VariantStackInfo_6632396365"
},
"oldVariantStack": {
"$ref": "#/components/schemas/VariantStackInfo"
}
},
"title": "FileModifiedVariantStack",
"type": "object"
},
"FileReplaced": {
"properties": {
"newFileName": {
"description": "The new fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileReplaced",
"type": "object"
},
"FileReplacedPreviewFile": {
"properties": {
"fileName": {
"description": "The fileName.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
"title": "FileReplacedPreviewFile",
"type": "object"
},
"FileState": {
"description": "The fileState.",
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"forceComment": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isArchive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForFileState"
}
},
"title": "FileState",
"type": "object"
},
"FileStateAssignPermissions": {
"properties": {
"assignAllFileStates": {
"type": "boolean"
},
"assignFileStateNoFileState": {
"type": "boolean"
},
"fileStatesToAssign": {
"items": {
"$ref": "#/components/schemas/FileStateBasic"
},
"type": "array"
}
},
"title": "FileStateAssignPermissions",
"type": "object"
},
"FileStateBasic": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"description": {
"type": "string"
},
"forceComment": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isArchive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileStateBasic",
"type": "object"
},
"FileStateInfo": {
"example": {
"id": 5,
"name": "FileState1"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileStateInfo",
"type": "object"
},
"FileStateModifiedColor": {
"properties": {
"newColor": {
"description": "The old color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldColor": {
"description": "The old color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "FileStateModifiedColor",
"type": "object"
},
"FileStateModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "FileStateModifiedDescription",
"type": "object"
},
"FileStateModifiedForceComment": {
"properties": {
"newForceComment": {
"description": "The new forceComment-flag.",
"type": "boolean"
},
"oldForceComment": {
"description": "The old forceComment-flag.",
"type": "boolean"
}
},
"title": "FileStateModifiedForceComment",
"type": "object"
},
"FileStateModifiedIsArchive": {
"properties": {
"newIsArchive": {
"description": "The new isArchive-flag.",
"type": "boolean"
},
"oldIsArchive": {
"description": "The old isArchive-flag.",
"type": "boolean"
}
},
"title": "FileStateModifiedIsArchive",
"type": "object"
},
"FileStateModifiedName": {
"properties": {
"newName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileStateModifiedName",
"type": "object"
},
"FileStateModifiedOrder": {
"properties": {
"newOrder": {
"description": "The new order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "The old order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileStateModifiedOrder",
"type": "object"
},
"FileStateShowPermissions": {
"properties": {
"fileStatesToShow": {
"items": {
"$ref": "#/components/schemas/FileStateBasic"
},
"type": "array"
},
"showAllFileStates": {
"type": "boolean"
},
"showFileStateNoFileState": {
"type": "boolean"
}
},
"title": "FileStateShowPermissions",
"type": "object"
},
"FileState_6161353832": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"forceComment": {
"type": "boolean"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isArchive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"order": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionsForFileState"
}
},
"title": "FileState",
"type": "object"
},
"FileVariantInfo": {
"example": {
"id": 1,
"linkName": "link"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"linkName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FileVariantInfo",
"type": "object"
},
"FilesAnalysis": {
"description": "\u003cp\u003eDetermines the fields which should be analyzed and how the fields should be analyzed.\u003c/p\u003e\n\u003cp\u003eLet's go through the keyword option from the example: At first the filter is applied to the files (if a filter is specified in the request). The filtered files are then analyzed. For the keyword option, the analyzer looks for the keywords, which occur the most in the resulting files. The keywords are ordered by number of occurrences in the response.\u003c/p\u003e\n\u003cp\u003eA result for the keyword option in the example could be:\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003etest\t 593\u003c/code\u003e \u003ccode\u003etester\t255\u003c/code\u003e \u003ccode\u003etestcase\t188\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eThe settings are interpreted as follows in the example: - limit: return 3 keywords maximally - mincount: the returned keywords must occur in at least 5 files - prefix: the returned keywords must have the prefix \u0026quot;test\u0026quot;\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003eshowAnalysis: true\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003erequired if: showAnalysis == true",
"example": {
"Address": null,
"Colorspace": {
"mincount": 1
},
"Directory": null,
"FileExtension": null,
"FileName": null,
"FileState": null,
"HasKeywords": null,
"IsLockedForDownload": null,
"Keyword": null,
"LicenseRelease": null,
"LicenseStatus": null,
"ModelRelease": null,
"Orientation": null,
"PropertyRelease": null,
"Rating": null,
"Size": null,
"Subject": null,
"User": null
},
"properties": {
"address": {
"$ref": "#/components/schemas/FilesAnalysisElement_6431633830"
},
"colorspace": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"directory": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
},
"fileExtension": {
"$ref": "#/components/schemas/FilesAnalysisElement_6431633830"
},
"fileName": {
"$ref": "#/components/schemas/FilesAnalysisElement_6431633830"
},
"fileState": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
},
"hasKeywords": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"isLockedForDownload": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"keyword": {
"$ref": "#/components/schemas/FilesAnalysisElement_6431633830"
},
"licenseRelease": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
},
"licenseStatus": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"modelRelease": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
},
"orientation": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"propertyRelease": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
},
"rating": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"size": {
"$ref": "#/components/schemas/FilesAnalysisElement"
},
"subject": {
"$ref": "#/components/schemas/FilesAnalysisElement_6431633830"
},
"user": {
"$ref": "#/components/schemas/FilesAnalysisElement_6265663362"
}
},
"title": "FilesAnalysis",
"type": "object"
},
"FilesAnalysisAttributeBool": {
"properties": {
"count": {
"type": "integer"
},
"value": {
"type": "boolean"
}
},
"title": "FilesAnalysisAttributeBool",
"type": "object"
},
"FilesAnalysisAttributeInt": {
"properties": {
"count": {
"type": "integer"
},
"value": {
"type": "integer"
}
},
"title": "FilesAnalysisAttributeInt",
"type": "object"
},
"FilesAnalysisAttributeString": {
"properties": {
"count": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"title": "FilesAnalysisAttributeString",
"type": "object"
},
"FilesAnalysisElement": {
"description": "A file analysis element.",
"example": "{\"mincount\": 1}",
"properties": {
"mincount": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "FilesAnalysisElement",
"type": "object"
},
"FilesAnalysisElement_6265663362": {
"description": "A file analysis element.",
"example": "{\"mincount\": 1, \"limit\": 10}",
"properties": {
"limit": {
"description": "The limit of the AnalysisOption. Determines the maximum amount of elements returned for this AnalysisOption.",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"mincount": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "FilesAnalysisElement",
"type": "object"
},
"FilesAnalysisElement_6431633830": {
"description": "A file analysis element.",
"example": "{\"mincount\": 1, \"limit\": 10, \"prefix\": \"foo\"}",
"properties": {
"limit": {
"description": "The limit of the AnalysisOption. Determines the maximum amount of elements returned for this AnalysisOption.",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"mincount": {
"description": "The returned field must occur in at least mincount files.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"prefix": {
"description": "The returned field must contain the determined prefix.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FilesAnalysisElement",
"type": "object"
},
"FilesAnalysis_3833636164": {
"description": "\u003cp\u003eThe result of the file analysis.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eNot exist when:\u003c/strong\u003e \u003ccode\u003eshowAnalysis: false\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eWhich keys of this map exist is determined by the specified analysis parameter.\u003c/p\u003e \u003c/blockquote\u003e ",
"properties": {
"address": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"colorspace": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"directory": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"fileExtension": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"fileName": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"fileState": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"hasKeywords": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeBool"
},
"type": "array"
},
"isLockedForDownload": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeBool"
},
"type": "array"
},
"keyword": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"licenseRelease": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"licenseStatus": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"modelRelease": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"orientation": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"propertyRelease": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"rating": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
},
"size": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"subject": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeString"
},
"type": "array"
},
"user": {
"items": {
"$ref": "#/components/schemas/FilesAnalysisAttributeInt"
},
"type": "array"
}
},
"title": "FilesAnalysis",
"type": "object"
},
"FilesDelete": {
"properties": {
"deletedFileIDs": {
"$ref": "#/components/schemas/ArraySchema_3335306239"
},
"notDeletedFileIDs": {
"$ref": "#/components/schemas/ArraySchema_3135383536"
}
},
"title": "filesDelete",
"type": "object"
},
"FilesDownload": {
"properties": {
"downloadURL": {
"$ref": "#/components/schemas/ArraySchema_3635653962"
},
"fileSize": {
"$ref": "#/components/schemas/ArraySchema_3933643866"
}
},
"title": "filesDownload",
"type": "object"
},
"FilesFilter": {
"description": "A filter to query for files.",
"example": {
"filterType": "connectorAnd",
"filters": [
{
"exactMatch": false,
"filterType": "searchTerm",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
{
"filterType": "rating",
"inverted": false,
"rating": 3
}
],
"inverted": false
},
"oneOf": [
{
"$ref": "#/components/schemas/FilesFilterAll"
},
{
"$ref": "#/components/schemas/FilesFilterCollection"
},
{
"$ref": "#/components/schemas/FilesFilterColorspace"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorAnd"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorOr"
},
{
"$ref": "#/components/schemas/FilesFilterCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterCreator"
},
{
"$ref": "#/components/schemas/FilesFilterDescription"
},
{
"$ref": "#/components/schemas/FilesFilterDirectory"
},
{
"$ref": "#/components/schemas/FilesFilterExternalShare"
},
{
"$ref": "#/components/schemas/FilesFilterFileExtension"
},
{
"$ref": "#/components/schemas/FilesFilterFileName"
},
{
"$ref": "#/components/schemas/FilesFilterFileState"
},
{
"$ref": "#/components/schemas/FilesFilterFileType"
},
{
"$ref": "#/components/schemas/FilesFilterFiles"
},
{
"$ref": "#/components/schemas/FilesFilterFormatType"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreator"
},
{
"$ref": "#/components/schemas/FilesFilterHasDescription"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiredLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiringLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasFileState"
},
{
"$ref": "#/components/schemas/FilesFilterHasKeywords"
},
{
"$ref": "#/components/schemas/FilesFilterHasLanguageCodes"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasLocation"
},
{
"$ref": "#/components/schemas/FilesFilterHasMetadataField"
},
{
"$ref": "#/components/schemas/FilesFilterHasModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasRating"
},
{
"$ref": "#/components/schemas/FilesFilterHasRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterHasUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterHasValidLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterHeight"
},
{
"$ref": "#/components/schemas/FilesFilterIsArchived"
},
{
"$ref": "#/components/schemas/FilesFilterIsCheckedOut"
},
{
"$ref": "#/components/schemas/FilesFilterIsConvertible"
},
{
"$ref": "#/components/schemas/FilesFilterIsDownloadLocked"
},
{
"$ref": "#/components/schemas/FilesFilterIsRotatable"
},
{
"$ref": "#/components/schemas/FilesFilterIsSubversion"
},
{
"$ref": "#/components/schemas/FilesFilterIsTrash"
},
{
"$ref": "#/components/schemas/FilesFilterKeyword"
},
{
"$ref": "#/components/schemas/FilesFilterLanguageCode"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterLocation"
},
{
"$ref": "#/components/schemas/FilesFilterLongSide"
},
{
"$ref": "#/components/schemas/FilesFilterMarkedUser"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldDate"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldLocation"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldSelection"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldText"
},
{
"$ref": "#/components/schemas/FilesFilterModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterModifyDate"
},
{
"$ref": "#/components/schemas/FilesFilterOrientation"
},
{
"$ref": "#/components/schemas/FilesFilterPerson"
},
{
"$ref": "#/components/schemas/FilesFilterPixel"
},
{
"$ref": "#/components/schemas/FilesFilterPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterRating"
},
{
"$ref": "#/components/schemas/FilesFilterRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterSearchTerm"
},
{
"$ref": "#/components/schemas/FilesFilterShortSide"
},
{
"$ref": "#/components/schemas/FilesFilterSubject"
},
{
"$ref": "#/components/schemas/FilesFilterUploadDate"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLinkGuestUserName"
},
{
"$ref": "#/components/schemas/FilesFilterUser"
},
{
"$ref": "#/components/schemas/FilesFilterVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterWidth"
}
],
"title": "FilesFilter",
"type": "object"
},
"FilesFilterAll": {
"example": {
"filterType": "all",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"all"
],
"example": "all",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterAll",
"type": "object"
},
"FilesFilterCollection": {
"example": {
"collectionID": 1,
"filterType": "collection",
"includeArchived": false,
"inverted": false
},
"properties": {
"collectionID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"collection"
],
"example": "collection",
"title": "FilesFilterType",
"type": "string"
},
"includeArchived": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterCollection",
"type": "object"
},
"FilesFilterColorspace": {
"example": {
"colorspace": "RGB",
"filterType": "colorspace",
"inverted": false
},
"properties": {
"colorspace": {
"description": "The colorspace of the image or video.",
"enum": [
"CMYK",
"GRAY",
"RGB",
"RGB"
],
"example": "RGB",
"title": "Colorspace",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"colorspace"
],
"example": "colorspace",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterColorspace",
"type": "object"
},
"FilesFilterConnectorAnd": {
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"connectorAnd"
],
"example": "connectorAnd",
"title": "FilesFilterType",
"type": "string"
},
"filters": {
"items": {
"$ref": "#/components/schemas/FilesFilter"
},
"type": "array"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterConnectorAnd",
"type": "object"
},
"FilesFilterConnectorOr": {
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"connectorOr"
],
"example": "connectorOr",
"title": "FilesFilterType",
"type": "string"
},
"filters": {
"items": {
"$ref": "#/components/schemas/FilesFilter"
},
"type": "array"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterConnectorOr",
"type": "object"
},
"FilesFilterCreateDate": {
"example": {
"dateMax": "2021-01-01 00:00:00",
"dateMin": "2021-01-01 00:00:00",
"filterType": "createDate",
"inverted": false
},
"properties": {
"dateMax": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"dateMin": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"createDate"
],
"example": "createDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterCreateDate",
"type": "object"
},
"FilesFilterCreator": {
"example": {
"exactMatch": false,
"filterType": "creator",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"creator"
],
"example": "creator",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterCreator",
"type": "object"
},
"FilesFilterDescription": {
"example": {
"exactMatch": false,
"filterType": "description",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"description"
],
"example": "description",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterDescription",
"type": "object"
},
"FilesFilterDirectory": {
"example": {
"directoryID": 1,
"filterType": "directory",
"includeSubdirectories": true,
"inverted": false
},
"properties": {
"directoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"directory"
],
"example": "directory",
"title": "FilesFilterType",
"type": "string"
},
"includeSubdirectories": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterDirectory",
"type": "object"
},
"FilesFilterExternalShare": {
"example": {
"externalShareID": 1,
"filterType": "externalShare",
"inverted": false
},
"properties": {
"externalShareID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"externalShare"
],
"example": "externalShare",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterExternalShare",
"type": "object"
},
"FilesFilterFileExtension": {
"example": {
"fileExtension": "jpg",
"filterType": "fileExtension",
"inverted": false
},
"properties": {
"fileExtension": {
"description": "FileExtension is an Entity for a FileExtension. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileExtension are replaced by one whitespace.",
"example": "JPG",
"title": "FileExtension",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"fileExtension"
],
"example": "fileExtension",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFileExtension",
"type": "object"
},
"FilesFilterFileName": {
"example": {
"exactMatch": false,
"filterType": "fileName",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"fileName"
],
"example": "fileName",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFileName",
"type": "object"
},
"FilesFilterFileState": {
"example": {
"fileStateID": 1,
"filterType": "fileState",
"inverted": false
},
"properties": {
"fileStateID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"fileState"
],
"example": "fileState",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFileState",
"type": "object"
},
"FilesFilterFileType": {
"example": {
"fileType": "image",
"filterType": "fileType",
"inverted": false
},
"properties": {
"fileType": {
"description": "FileType is an Entity for a FileType. The FileType is determined by the aspect ratio of the file.",
"enum": [
"audio",
"image",
"video"
],
"example": "image",
"title": "FileType",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"fileType"
],
"example": "fileType",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFileType",
"type": "object"
},
"FilesFilterFiles": {
"example": {
"fileIDs": [
1,
2
],
"filterType": "files",
"inverted": false
},
"properties": {
"fileIDs": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"files"
],
"example": "files",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFiles",
"type": "object"
},
"FilesFilterFormatType": {
"example": {
"filterType": "formatType",
"formatType": "image",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"formatType"
],
"example": "formatType",
"title": "FilesFilterType",
"type": "string"
},
"formatType": {
"description": "FormatType is an Entity for a FormatType. A FormatType describes a set of FileBasic Extensions, the Web FormatType for example consists of the FileBasic Extensions JPG, JPEG, GIF and PNG.",
"enum": [
"archive",
"audio",
"converted",
"image",
"imageconverted",
"office",
"other",
"pdf",
"raw",
"raw-image",
"vector",
"video",
"web",
"web-image",
"webimage"
],
"example": "web",
"title": "FormatType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterFormatType",
"type": "object"
},
"FilesFilterHasCreateDate": {
"example": {
"filterType": "hasCreateDate",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasCreateDate"
],
"example": "hasCreateDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasCreateDate",
"type": "object"
},
"FilesFilterHasCreator": {
"example": {
"filterType": "hasCreator",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasCreator"
],
"example": "hasCreator",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasCreator",
"type": "object"
},
"FilesFilterHasDescription": {
"example": {
"filterType": "hasDescription",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasDescription"
],
"example": "hasDescription",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasDescription",
"type": "object"
},
"FilesFilterHasExpiredLicense": {
"example": {
"filterType": "hasExpiredLicense",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasExpiredLicense"
],
"example": "hasExpiredLicense",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasExpiredLicense",
"type": "object"
},
"FilesFilterHasExpiringLicense": {
"example": {
"days": 1,
"filterType": "hasExpiringLicense",
"inverted": false
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasExpiringLicense"
],
"example": "hasExpiringLicense",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasExpiringLicense",
"type": "object"
},
"FilesFilterHasFileState": {
"example": {
"filterType": "hasFileState",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasFileState"
],
"example": "hasFileState",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasFileState",
"type": "object"
},
"FilesFilterHasKeywords": {
"example": {
"filterType": "hasKeywords",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasKeywords"
],
"example": "hasKeywords",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasKeywords",
"type": "object"
},
"FilesFilterHasLanguageCodes": {
"example": {
"filterType": "hasLanguageCodes",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasLanguageCodes"
],
"example": "hasLanguageCodes",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasLanguageCodes",
"type": "object"
},
"FilesFilterHasLicenseExpirationDate": {
"example": {
"filterType": "hasLicenseExpirationDate",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasLicenseExpirationDate"
],
"example": "hasLicenseExpirationDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasLicenseExpirationDate",
"type": "object"
},
"FilesFilterHasLicenseFile": {
"example": {
"filterType": "hasLicenseRelease",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasLicenseRelease"
],
"example": "hasLicenseRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasLicenseFile",
"type": "object"
},
"FilesFilterHasLocation": {
"example": {
"filterType": "hasLocation",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasLocation"
],
"example": "hasLocation",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasLocation",
"type": "object"
},
"FilesFilterHasMetadataField": {
"example": {
"customMetadataFieldID": 1,
"filterType": "hasMetadataField",
"inverted": false,
"metadataFieldID": 1,
"standardMetadataFieldID": 1
},
"properties": {
"customMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasMetadataField"
],
"example": "hasMetadataField",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"standardMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterHasMetadataField",
"type": "object"
},
"FilesFilterHasModelFile": {
"example": {
"filterType": "hasModelRelease",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasModelRelease"
],
"example": "hasModelRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasModelFile",
"type": "object"
},
"FilesFilterHasPropertyFile": {
"example": {
"filterType": "hasPropertyRelease",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasPropertyRelease"
],
"example": "hasPropertyRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasPropertyFile",
"type": "object"
},
"FilesFilterHasRating": {
"example": {
"filterType": "hasRating",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasRating"
],
"example": "hasRating",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasRating",
"type": "object"
},
"FilesFilterHasRecognizedText": {
"example": {
"filterType": "hasRecognizedText",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasRecognizedText"
],
"example": "hasRecognizedText",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasRecognizedText",
"type": "object"
},
"FilesFilterHasUploadLink": {
"example": {
"filterType": "hasUploadLink",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasUploadLink"
],
"example": "hasUploadLink",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasUploadLink",
"type": "object"
},
"FilesFilterHasValidLicense": {
"example": {
"filterType": "hasValidLicense",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasValidLicense"
],
"example": "hasValidLicense",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasValidLicense",
"type": "object"
},
"FilesFilterHasVariantStack": {
"example": {
"filterType": "hasVariantStack",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"hasVariantStack"
],
"example": "hasVariantStack",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterHasVariantStack",
"type": "object"
},
"FilesFilterHeight": {
"example": {
"filterType": "height",
"inverted": false,
"max": 1,
"min": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"height"
],
"example": "height",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"max": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"min": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FilesFilterHeight",
"type": "object"
},
"FilesFilterIsArchived": {
"example": {
"filterType": "isArchived",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isArchived"
],
"example": "isArchived",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsArchived",
"type": "object"
},
"FilesFilterIsCheckedOut": {
"example": {
"filterType": "isCheckedOut",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isCheckedOut"
],
"example": "isCheckedOut",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsCheckedOut",
"type": "object"
},
"FilesFilterIsConvertible": {
"example": {
"filterType": "isConvertible",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isConvertible"
],
"example": "isConvertible",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsConvertible",
"type": "object"
},
"FilesFilterIsDownloadLocked": {
"example": {
"filterType": "isDownloadLocked",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isDownloadLocked"
],
"example": "isDownloadLocked",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsDownloadLocked",
"type": "object"
},
"FilesFilterIsRotatable": {
"example": {
"filterType": "isRotatable",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isRotatable"
],
"example": "isRotatable",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsRotatable",
"type": "object"
},
"FilesFilterIsSubversion": {
"example": {
"filterType": "isSubversion",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isSubversion"
],
"example": "isSubversion",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsSubversion",
"type": "object"
},
"FilesFilterIsTrash": {
"example": {
"filterType": "isTrash",
"inverted": false
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"isTrash"
],
"example": "isTrash",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterIsTrash",
"type": "object"
},
"FilesFilterKeyword": {
"example": {
"exactMatch": false,
"filterType": "keyword",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"keyword"
],
"example": "keyword",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterKeyword",
"type": "object"
},
"FilesFilterLanguageCode": {
"example": {
"exactMatch": false,
"filterType": "languageCode",
"inverted": false,
"languageCode": "en"
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"languageCode"
],
"example": "languageCode",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"languageCode": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "FilesFilterLanguageCode",
"type": "object"
},
"FilesFilterLicenseExpirationDate": {
"example": {
"dateMax": "2021-01-01 00:00:00",
"dateMin": "2021-01-01 00:00:00",
"filterType": "licenseExpirationDate",
"inverted": false
},
"properties": {
"dateMax": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"dateMin": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"licenseExpirationDate"
],
"example": "licenseExpirationDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterLicenseExpirationDate",
"type": "object"
},
"FilesFilterLicenseFile": {
"example": {
"filterType": "licenseRelease",
"inverted": false,
"licenseReleaseID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"licenseRelease"
],
"example": "licenseRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"licenseReleaseID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterLicenseFile",
"type": "object"
},
"FilesFilterLocation": {
"example": {
"filterType": "location",
"inverted": false,
"location": {
"latitude": 1,
"longitude": 1,
"radius": null
}
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"location"
],
"example": "location",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"location": {
"$ref": "#/components/schemas/LocationFilter"
}
},
"title": "FilesFilterLocation",
"type": "object"
},
"FilesFilterLongSide": {
"example": {
"filterType": "longSide",
"inverted": false,
"max": 1,
"min": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"longSide"
],
"example": "longSide",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"max": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"min": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FilesFilterLongSide",
"type": "object"
},
"FilesFilterMarkedUser": {
"description": "A filter for files marked by a user. Exactly one of markedUserID or useCurrentUserID must be set; useCurrentUserID defaults to false.",
"example": {
"filterType": "markedUser",
"inverted": false,
"markedUserID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"markedUser"
],
"example": "markedUser",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"markedUserID": {
"description": "The ID of the user whose marked files are queried. Exactly one of markedUserID or useCurrentUserID must be set.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"useCurrentUserID": {
"default": false,
"description": "If true, queries the marked files of the currently authenticated user. Exactly one of markedUserID or useCurrentUserID must be set. Defaults to false.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterMarkedUser",
"type": "object"
},
"FilesFilterMetadataFieldDate": {
"example": {
"customMetadataFieldID": 1,
"dateMax": "2021-01-01 00:00:00",
"dateMin": "2021-01-01 00:00:00",
"filterType": "metadataFieldDate",
"inverted": false,
"metadataFieldID": 1,
"standardMetadataFieldID": 1
},
"properties": {
"customMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"dateMax": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"dateMin": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"metadataFieldDate"
],
"example": "metadataFieldDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"standardMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterMetadataFieldDate",
"type": "object"
},
"FilesFilterMetadataFieldLocation": {
"example": {
"customMetadataFieldID": 1,
"filterType": "metadataFieldLocation",
"inverted": false,
"location": {
"latitude": 1,
"longitude": 1,
"radius": 100
},
"metadataFieldID": 1,
"standardMetadataFieldID": 1
},
"properties": {
"customMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"metadataFieldLocation"
],
"example": "metadataFieldLocation",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"location": {
"$ref": "#/components/schemas/LocationFilter"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"standardMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterMetadataFieldLocation",
"type": "object"
},
"FilesFilterMetadataFieldSelection": {
"example": {
"customMetadataFieldID": 1,
"filterType": "metadataFieldSelection",
"inverted": false,
"selectionOptionID": 1,
"standardMetadataFieldID": 1
},
"properties": {
"customMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"metadataFieldSelection"
],
"example": "metadataFieldSelection",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"selectionOptionID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"standardMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterMetadataFieldSelection",
"type": "object"
},
"FilesFilterMetadataFieldText": {
"example": {
"customMetadataFieldID": 1,
"exactMatch": false,
"filterType": "metadataFieldText",
"inverted": false,
"metadataFieldID": 1,
"standardMetadataFieldID": 1,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"customMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"metadataFieldText"
],
"example": "metadataFieldText",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"standardMetadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterMetadataFieldText",
"type": "object"
},
"FilesFilterModelFile": {
"example": {
"filterType": "modelRelease",
"inverted": false,
"modelReleaseID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"modelRelease"
],
"example": "modelRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"modelReleaseID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterModelFile",
"type": "object"
},
"FilesFilterModifyDate": {
"example": {
"dateMax": "2021-01-01 00:00:00",
"dateMin": "2021-01-01 00:00:00",
"filterType": "modifyDate",
"inverted": false
},
"properties": {
"dateMax": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"dateMin": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"modifyDate"
],
"example": "modifyDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterModifyDate",
"type": "object"
},
"FilesFilterOrientation": {
"example": {
"filterType": "orientation",
"inverted": false,
"orientation": "portrait"
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"orientation"
],
"example": "orientation",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"orientation": {
"enum": [
"landscape",
"portrait",
"square",
"widescreen"
],
"example": "portrait",
"title": "Orientation",
"type": "string"
}
},
"title": "FilesFilterOrientation",
"type": "object"
},
"FilesFilterPerson": {
"example": {
"filterType": "person",
"inverted": false,
"personID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"person"
],
"example": "person",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"personID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterPerson",
"type": "object"
},
"FilesFilterPixel": {
"example": {
"filterType": "pixel",
"inverted": false,
"max": 1,
"min": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"pixel"
],
"example": "pixel",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"max": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"min": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FilesFilterPixel",
"type": "object"
},
"FilesFilterPropertyFile": {
"example": {
"filterType": "propertyRelease",
"inverted": false,
"propertyReleaseID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"propertyRelease"
],
"example": "propertyRelease",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"propertyReleaseID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterPropertyFile",
"type": "object"
},
"FilesFilterRating": {
"example": {
"filterType": "rating",
"inverted": false,
"rating": 3
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"rating"
],
"example": "rating",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"rating": {
"description": "The rating of the file.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
}
},
"title": "FilesFilterRating",
"type": "object"
},
"FilesFilterRecognizedText": {
"example": {
"exactMatch": false,
"filterType": "recognizedText",
"inverted": false,
"term": "word"
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"recognizedText"
],
"example": "recognizedText",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FilesFilterRecognizedText",
"type": "object"
},
"FilesFilterSearchTerm": {
"example": {
"exactMatch": false,
"filterType": "searchTerm",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"searchTerm"
],
"example": "searchTerm",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterSearchTerm",
"type": "object"
},
"FilesFilterShortSide": {
"example": {
"filterType": "shortSide",
"inverted": false,
"max": 1,
"min": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"shortSide"
],
"example": "shortSide",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"max": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"min": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FilesFilterShortSide",
"type": "object"
},
"FilesFilterSubject": {
"example": {
"exactMatch": false,
"filterType": "subject",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
"properties": {
"exactMatch": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"subject"
],
"example": "subject",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"term": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"useSynonyms": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterSubject",
"type": "object"
},
"FilesFilterUploadDate": {
"example": {
"dateMax": "2021-01-01 00:00:00",
"dateMin": "2021-01-01 00:00:00",
"filterType": "uploadDate",
"inverted": false
},
"properties": {
"dateMax": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"dateMin": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"uploadDate"
],
"example": "uploadDate",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"title": "FilesFilterUploadDate",
"type": "object"
},
"FilesFilterUploadLink": {
"example": {
"filterType": "uploadLink",
"inverted": false,
"uploadLinkID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"uploadLink"
],
"example": "uploadLink",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadLinkID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterUploadLink",
"type": "object"
},
"FilesFilterUploadLinkGuestUserName": {
"example": {
"filterType": "uploadLinkGuestUserName",
"inverted": false,
"uploadLinkGuestUserName": "guest"
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"uploadLinkGuestUserName"
],
"example": "uploadLinkGuestUserName",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadLinkGuestUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FilesFilterUploadLinkGuestUserName",
"type": "object"
},
"FilesFilterUser": {
"example": {
"filterType": "user",
"inverted": false,
"userID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"user"
],
"example": "user",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"userID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterUser",
"type": "object"
},
"FilesFilterVariantStack": {
"example": {
"filterType": "variantStack",
"inverted": false,
"variantStackID": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"variantStack"
],
"example": "variantStack",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"variantStackID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "FilesFilterVariantStack",
"type": "object"
},
"FilesFilterWidth": {
"example": {
"filterType": "width",
"inverted": false,
"max": 1,
"min": 1
},
"properties": {
"filterType": {
"description": "The type of the FilesFilter.",
"enum": [
"width"
],
"example": "width",
"title": "FilesFilterType",
"type": "string"
},
"inverted": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"max": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"min": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "FilesFilterWidth",
"type": "object"
},
"FilesFilter_3735303438": {
"description": "The new filter.",
"example": {
"filterType": "connectorAnd",
"filters": [
{
"exactMatch": false,
"filterType": "searchTerm",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
{
"filterType": "rating",
"inverted": false,
"rating": 3
}
],
"inverted": false
},
"oneOf": [
{
"$ref": "#/components/schemas/FilesFilterAll"
},
{
"$ref": "#/components/schemas/FilesFilterCollection"
},
{
"$ref": "#/components/schemas/FilesFilterColorspace"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorAnd"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorOr"
},
{
"$ref": "#/components/schemas/FilesFilterCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterCreator"
},
{
"$ref": "#/components/schemas/FilesFilterDescription"
},
{
"$ref": "#/components/schemas/FilesFilterDirectory"
},
{
"$ref": "#/components/schemas/FilesFilterExternalShare"
},
{
"$ref": "#/components/schemas/FilesFilterFileExtension"
},
{
"$ref": "#/components/schemas/FilesFilterFileName"
},
{
"$ref": "#/components/schemas/FilesFilterFileState"
},
{
"$ref": "#/components/schemas/FilesFilterFileType"
},
{
"$ref": "#/components/schemas/FilesFilterFiles"
},
{
"$ref": "#/components/schemas/FilesFilterFormatType"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreator"
},
{
"$ref": "#/components/schemas/FilesFilterHasDescription"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiredLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiringLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasFileState"
},
{
"$ref": "#/components/schemas/FilesFilterHasKeywords"
},
{
"$ref": "#/components/schemas/FilesFilterHasLanguageCodes"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasLocation"
},
{
"$ref": "#/components/schemas/FilesFilterHasMetadataField"
},
{
"$ref": "#/components/schemas/FilesFilterHasModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasRating"
},
{
"$ref": "#/components/schemas/FilesFilterHasRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterHasUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterHasValidLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterHeight"
},
{
"$ref": "#/components/schemas/FilesFilterIsArchived"
},
{
"$ref": "#/components/schemas/FilesFilterIsCheckedOut"
},
{
"$ref": "#/components/schemas/FilesFilterIsConvertible"
},
{
"$ref": "#/components/schemas/FilesFilterIsDownloadLocked"
},
{
"$ref": "#/components/schemas/FilesFilterIsRotatable"
},
{
"$ref": "#/components/schemas/FilesFilterIsSubversion"
},
{
"$ref": "#/components/schemas/FilesFilterIsTrash"
},
{
"$ref": "#/components/schemas/FilesFilterKeyword"
},
{
"$ref": "#/components/schemas/FilesFilterLanguageCode"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterLocation"
},
{
"$ref": "#/components/schemas/FilesFilterLongSide"
},
{
"$ref": "#/components/schemas/FilesFilterMarkedUser"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldDate"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldLocation"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldSelection"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldText"
},
{
"$ref": "#/components/schemas/FilesFilterModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterModifyDate"
},
{
"$ref": "#/components/schemas/FilesFilterOrientation"
},
{
"$ref": "#/components/schemas/FilesFilterPerson"
},
{
"$ref": "#/components/schemas/FilesFilterPixel"
},
{
"$ref": "#/components/schemas/FilesFilterPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterRating"
},
{
"$ref": "#/components/schemas/FilesFilterRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterSearchTerm"
},
{
"$ref": "#/components/schemas/FilesFilterShortSide"
},
{
"$ref": "#/components/schemas/FilesFilterSubject"
},
{
"$ref": "#/components/schemas/FilesFilterUploadDate"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLinkGuestUserName"
},
{
"$ref": "#/components/schemas/FilesFilterUser"
},
{
"$ref": "#/components/schemas/FilesFilterVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterWidth"
}
],
"title": "FilesFilter",
"type": "object"
},
"FilesFilter_6637343634": {
"description": "The old filter.",
"example": {
"filterType": "connectorAnd",
"filters": [
{
"exactMatch": false,
"filterType": "searchTerm",
"inverted": false,
"term": "hello+world",
"useSynonyms": true
},
{
"filterType": "rating",
"inverted": false,
"rating": 3
}
],
"inverted": false
},
"oneOf": [
{
"$ref": "#/components/schemas/FilesFilterAll"
},
{
"$ref": "#/components/schemas/FilesFilterCollection"
},
{
"$ref": "#/components/schemas/FilesFilterColorspace"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorAnd"
},
{
"$ref": "#/components/schemas/FilesFilterConnectorOr"
},
{
"$ref": "#/components/schemas/FilesFilterCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterCreator"
},
{
"$ref": "#/components/schemas/FilesFilterDescription"
},
{
"$ref": "#/components/schemas/FilesFilterDirectory"
},
{
"$ref": "#/components/schemas/FilesFilterExternalShare"
},
{
"$ref": "#/components/schemas/FilesFilterFileExtension"
},
{
"$ref": "#/components/schemas/FilesFilterFileName"
},
{
"$ref": "#/components/schemas/FilesFilterFileState"
},
{
"$ref": "#/components/schemas/FilesFilterFileType"
},
{
"$ref": "#/components/schemas/FilesFilterFiles"
},
{
"$ref": "#/components/schemas/FilesFilterFormatType"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreateDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasCreator"
},
{
"$ref": "#/components/schemas/FilesFilterHasDescription"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiredLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasExpiringLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasFileState"
},
{
"$ref": "#/components/schemas/FilesFilterHasKeywords"
},
{
"$ref": "#/components/schemas/FilesFilterHasLanguageCodes"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterHasLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasLocation"
},
{
"$ref": "#/components/schemas/FilesFilterHasMetadataField"
},
{
"$ref": "#/components/schemas/FilesFilterHasModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterHasRating"
},
{
"$ref": "#/components/schemas/FilesFilterHasRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterHasUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterHasValidLicense"
},
{
"$ref": "#/components/schemas/FilesFilterHasVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterHeight"
},
{
"$ref": "#/components/schemas/FilesFilterIsArchived"
},
{
"$ref": "#/components/schemas/FilesFilterIsCheckedOut"
},
{
"$ref": "#/components/schemas/FilesFilterIsConvertible"
},
{
"$ref": "#/components/schemas/FilesFilterIsDownloadLocked"
},
{
"$ref": "#/components/schemas/FilesFilterIsRotatable"
},
{
"$ref": "#/components/schemas/FilesFilterIsSubversion"
},
{
"$ref": "#/components/schemas/FilesFilterIsTrash"
},
{
"$ref": "#/components/schemas/FilesFilterKeyword"
},
{
"$ref": "#/components/schemas/FilesFilterLanguageCode"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseExpirationDate"
},
{
"$ref": "#/components/schemas/FilesFilterLicenseFile"
},
{
"$ref": "#/components/schemas/FilesFilterLocation"
},
{
"$ref": "#/components/schemas/FilesFilterLongSide"
},
{
"$ref": "#/components/schemas/FilesFilterMarkedUser"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldDate"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldLocation"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldSelection"
},
{
"$ref": "#/components/schemas/FilesFilterMetadataFieldText"
},
{
"$ref": "#/components/schemas/FilesFilterModelFile"
},
{
"$ref": "#/components/schemas/FilesFilterModifyDate"
},
{
"$ref": "#/components/schemas/FilesFilterOrientation"
},
{
"$ref": "#/components/schemas/FilesFilterPerson"
},
{
"$ref": "#/components/schemas/FilesFilterPixel"
},
{
"$ref": "#/components/schemas/FilesFilterPropertyFile"
},
{
"$ref": "#/components/schemas/FilesFilterRating"
},
{
"$ref": "#/components/schemas/FilesFilterRecognizedText"
},
{
"$ref": "#/components/schemas/FilesFilterSearchTerm"
},
{
"$ref": "#/components/schemas/FilesFilterShortSide"
},
{
"$ref": "#/components/schemas/FilesFilterSubject"
},
{
"$ref": "#/components/schemas/FilesFilterUploadDate"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLink"
},
{
"$ref": "#/components/schemas/FilesFilterUploadLinkGuestUserName"
},
{
"$ref": "#/components/schemas/FilesFilterUser"
},
{
"$ref": "#/components/schemas/FilesFilterVariantStack"
},
{
"$ref": "#/components/schemas/FilesFilterWidth"
}
],
"title": "FilesFilter",
"type": "object"
},
"FilesModify": {
"properties": {
"modifiedFileIDs": {
"$ref": "#/components/schemas/ArraySchema_6661303537"
},
"notModifiedFileIDs": {
"$ref": "#/components/schemas/ArraySchema_3038633065"
}
},
"title": "filesModify",
"type": "object"
},
"FilesReplacePreviewFile": {
"properties": {
"fileID": {
"description": "The id of the file.",
"example": 12,
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
}
},
"title": "filesReplacePreviewFile",
"type": "object"
},
"FilesUpload": {
"properties": {
"fileID": {
"description": "The id of the uploaded file.",
"example": 12,
"exclusiveMinimum": true,
"minimum": 0,
"type": "integer"
},
"isDuplicate": {
"description": "The flag indicates if the file is a duplicate or not.",
"example": true,
"type": "boolean"
},
"storageUsage": {
"description": "The storageUsage of the system in percent.",
"example": "56",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"title": "filesUpload",
"type": "object"
},
"FilterModified": {
"properties": {
"newFilter": {
"$ref": "#/components/schemas/FilesFilter_3735303438"
},
"oldFilter": {
"$ref": "#/components/schemas/FilesFilter_6637343634"
}
},
"title": "FilterModified",
"type": "object"
},
"FilterModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "FilterModifiedName",
"type": "object"
},
"FilterModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newUserName": {
"description": "The new userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserName": {
"description": "The old userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "FilterModifiedUserID",
"type": "object"
},
"FocalPoint": {
"description": "The old focalPoint.",
"example": {
"x": 0.5,
"y": 0.5
},
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"title": "FocalPoint",
"type": "object"
},
"FocalPoint_3566613430": {
"description": "The new focalPoint.",
"example": {
"x": 0.5,
"y": 0.5
},
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"title": "FocalPoint",
"type": "object"
},
"FocalPoint_6433356230": {
"description": "FocalPoint is a struct that defines the focal point of an image.",
"example": {
"x": 0.5,
"y": 0.5
},
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"title": "FocalPoint",
"type": "object"
},
"FormatConversion": {
"additionalProperties": {
"type": "string"
},
"description": "The new formatConversion.",
"example": {
"alle": "jpg"
},
"title": "FormatConversion",
"type": "object"
},
"FormatConversion_3434303634": {
"additionalProperties": {
"type": "string"
},
"description": "The old formatConversion.",
"example": {
"alle": "jpg"
},
"title": "FormatConversion",
"type": "object"
},
"FormatConversion_6435353034": {
"additionalProperties": {
"type": "string"
},
"description": "\u003cp\u003eThe formatConversion map. The Keys are the source format for the formatConversion. Valid Keys: all, jpg, png, ai, eps, psd, tiff The Values are the destination format for the formatConversion. Valid Values: jpg, pdf, png, tiff, webp\u003c/p\u003e ",
"example": {
"alle": "jpg"
},
"title": "FormatConversion",
"type": "object"
},
"GeneralSettingsModifiedAllowConcurrentLogin": {
"properties": {
"newAllowConcurrentLogin": {
"description": "The new allowConcurrentLogin-flag.",
"type": "boolean"
},
"oldAllowConcurrentLogin": {
"description": "The old allowConcurrentLogin-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedAllowConcurrentLogin",
"type": "object"
},
"GeneralSettingsModifiedAllowDuplicates": {
"properties": {
"newAllowDuplicates": {
"description": "The new allowDuplicates-flag.",
"type": "boolean"
},
"oldAllowDuplicates": {
"description": "The old allowDuplicates-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedAllowDuplicates",
"type": "object"
},
"GeneralSettingsModifiedCheckSessionFiles": {
"properties": {
"newCheckSessionFiles": {
"description": "The new checkSessionFiles-flag.",
"type": "boolean"
},
"oldCheckSessionFiles": {
"description": "The old checkSessionFiles-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedCheckSessionFiles",
"type": "object"
},
"GeneralSettingsModifiedDailyAPILimit": {
"properties": {
"newDailyAPILimit": {
"description": "The old dailyAPILimit-flag.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldDailyAPILimit": {
"description": "The old dailyAPILimit-flag.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedDailyAPILimit",
"type": "object"
},
"GeneralSettingsModifiedDataPrivacyText": {
"properties": {
"newDataPrivacyText": {
"description": "The new dataPrivacyText.",
"type": "string"
},
"oldDataPrivacyText": {
"description": "The old dataPrivacyText.",
"type": "string"
}
},
"title": "GeneralSettingsModifiedDataPrivacyText",
"type": "object"
},
"GeneralSettingsModifiedDataPrivacyURL": {
"properties": {
"newDataPrivacyURL": {
"description": "The new dataPrivacyURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldDataPrivacyURL": {
"description": "The old dataPrivacyURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "GeneralSettingsModifiedDataPrivacyURL",
"type": "object"
},
"GeneralSettingsModifiedDefaultLanguageCodesAdded": {
"properties": {
"defaultLanguageCodesAdded": {
"$ref": "#/components/schemas/ArraySchema_3734303064"
}
},
"title": "GeneralSettingsModifiedDefaultLanguageCodesAdded",
"type": "object"
},
"GeneralSettingsModifiedDefaultLanguageCodesRemoved": {
"properties": {
"defaultLanguageCodesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3364303330"
}
},
"title": "GeneralSettingsModifiedDefaultLanguageCodesRemoved",
"type": "object"
},
"GeneralSettingsModifiedDirectoriesInMediaview": {
"properties": {
"newDirectoriesInMediaview": {
"description": "The new DirectoriesInMediaview-flag.",
"type": "boolean"
},
"oldDirectoriesInMediaview": {
"description": "The old DirectoriesInMediaview-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedDirectoriesInMediaview",
"type": "object"
},
"GeneralSettingsModifiedDownloadCacheSize": {
"properties": {
"newDownloadCacheSize": {
"description": "The new downloadCacheSize.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldDownloadCacheSize": {
"description": "The old downloadCacheSize.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedDownloadCacheSize",
"type": "object"
},
"GeneralSettingsModifiedDownloadCacheStoreCroppedFiles": {
"properties": {
"newDownloadCacheStoreCroppedFiles": {
"description": "The new downloadCacheStoreCroppedFiles-flag.",
"type": "boolean"
},
"oldDownloadCacheStoreCroppedFiles": {
"description": "The old downloadCacheStoreCroppedFiles-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedDownloadCacheStoreCroppedFiles",
"type": "object"
},
"GeneralSettingsModifiedDownloadCacheTime": {
"properties": {
"newDownloadCacheTime": {
"description": "The new downloadCacheTime.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldDownloadCacheTime": {
"description": "The old downloadCacheTime.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedDownloadCacheTime",
"type": "object"
},
"GeneralSettingsModifiedDownloadLockedText": {
"properties": {
"newDownloadLockedText": {
"description": "The new downloadLockedText.",
"type": "string"
},
"oldDownloadLockedText": {
"description": "The old downloadLockedText.",
"type": "string"
}
},
"title": "GeneralSettingsModifiedDownloadLockedText",
"type": "object"
},
"GeneralSettingsModifiedEnableForgotPasswordOption": {
"properties": {
"newEnableForgotPasswordOption": {
"description": "The new enableForgotPasswordOption-flag.",
"type": "boolean"
},
"oldEnableForgotPasswordOption": {
"description": "The old enableForgotPasswordOption-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedEnableForgotPasswordOption",
"type": "object"
},
"GeneralSettingsModifiedExternalShareAlias": {
"properties": {
"newExternalShareAlias": {
"description": "The new externalShareAlias.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldExternalShareAlias": {
"description": "The old externalShareAlias.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "GeneralSettingsModifiedExternalShareAlias",
"type": "object"
},
"GeneralSettingsModifiedFaceRecognition": {
"properties": {
"newFaceRecognition": {
"description": "The new FaceRecognition-flag.",
"type": "boolean"
},
"oldFaceRecognition": {
"description": "The old FaceRecognition-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedFaceRecognition",
"type": "object"
},
"GeneralSettingsModifiedGeneralUploadText": {
"properties": {
"newGeneralUploadText": {
"description": "The new generalUploadText.",
"type": "string"
},
"oldGeneralUploadText": {
"description": "The old generalUploadText.",
"type": "string"
}
},
"title": "GeneralSettingsModifiedGeneralUploadText",
"type": "object"
},
"GeneralSettingsModifiedKeywordUploadText": {
"properties": {
"newKeywordUploadText": {
"description": "The new keywordUploadText.",
"type": "string"
},
"oldKeywordUploadText": {
"description": "The old keywordUploadText.",
"type": "string"
}
},
"title": "GeneralSettingsModifiedKeywordUploadText",
"type": "object"
},
"GeneralSettingsModifiedKeywordsBoundToPermissionGroups": {
"properties": {
"newKeywordsBoundToPermissionGroups": {
"description": "The old keywordsBoundToPermissionGroups-flag.",
"type": "boolean"
},
"oldKeywordsBoundToPermissionGroups": {
"description": "The old keywordsBoundToPermissionGroups-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedKeywordsBoundToPermissionGroups",
"type": "object"
},
"GeneralSettingsModifiedLegalNoticeText": {
"properties": {
"newLegalNoticeText": {
"description": "The new legalNoticeText.",
"type": "string"
},
"oldLegalNoticeText": {
"description": "The old legalNoticeText.",
"type": "string"
}
},
"title": "GeneralSettingsModifiedLegalNoticeText",
"type": "object"
},
"GeneralSettingsModifiedLegalNoticeURL": {
"properties": {
"newLegalNoticeURL": {
"description": "The new legalNoticeURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldLegalNoticeURL": {
"description": "The old legalNoticeURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "GeneralSettingsModifiedLegalNoticeURL",
"type": "object"
},
"GeneralSettingsModifiedMetadataFieldsOrder": {
"properties": {
"newMetadataFieldsOrder": {
"$ref": "#/components/schemas/ArraySchema_6539356565"
},
"oldMetadataFieldsOrder": {
"$ref": "#/components/schemas/ArraySchema_3035636363"
}
},
"title": "GeneralSettingsModifiedMetadataFieldsOrder",
"type": "object"
},
"GeneralSettingsModifiedPasswordSecurityLevel": {
"properties": {
"newPasswordSecurityLevel": {
"description": "The new passwordSecurityLevel.",
"enum": [
"SecurityLevel1",
"SecurityLevel2",
"SecurityLevel3",
"Unsafe"
],
"example": "Unsafe",
"title": "PasswordSecurityLevel",
"type": "string"
},
"oldPasswordSecurityLevel": {
"description": "The old passwordSecurityLevel.",
"enum": [
"SecurityLevel1",
"SecurityLevel2",
"SecurityLevel3",
"Unsafe"
],
"example": "Unsafe",
"title": "PasswordSecurityLevel",
"type": "string"
}
},
"title": "GeneralSettingsModifiedPasswordSecurityLevel",
"type": "object"
},
"GeneralSettingsModifiedSecondAPILimit": {
"properties": {
"newSecondAPILimit": {
"description": "The old secondAPILimit-flag.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldSecondAPILimit": {
"description": "The old secondAPILimit-flag.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedSecondAPILimit",
"type": "object"
},
"GeneralSettingsModifiedSemanticSearch": {
"properties": {
"newSemanticSearch": {
"description": "The new SemanticSearch-flag.",
"type": "boolean"
},
"oldSemanticSearch": {
"description": "The old SemanticSearch-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedSemanticSearch",
"type": "object"
},
"GeneralSettingsModifiedSessionTimeout": {
"properties": {
"newSessionTimeout": {
"description": "The new sessionTimeout.",
"type": "integer"
},
"oldSessionTimeout": {
"description": "The old sessionTimeout.",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedSessionTimeout",
"type": "object"
},
"GeneralSettingsModifiedShowChat": {
"properties": {
"newShowChat": {
"description": "The new showChat-flag.",
"type": "boolean"
},
"oldShowChat": {
"description": "The old showChat-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedShowChat",
"type": "object"
},
"GeneralSettingsModifiedShowFileOwner": {
"properties": {
"newShowFileOwner": {
"description": "The new showFileOwner-flag.",
"type": "boolean"
},
"oldShowFileOwner": {
"description": "The old showFileOwner-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedShowFileOwner",
"type": "object"
},
"GeneralSettingsModifiedShowUnimportantMetadataFields": {
"properties": {
"newShowUnimportantMetadataFields": {
"description": "The new showUnimportantMetadataFields-flag.",
"type": "boolean"
},
"oldShowUnimportantMetadataFields": {
"description": "The old showUnimportantMetadataFields-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedShowUnimportantMetadataFields",
"type": "object"
},
"GeneralSettingsModifiedSmartTagging": {
"properties": {
"newSmartTagging": {
"description": "The new smartTagging-flag.",
"type": "boolean"
},
"oldSmartTagging": {
"description": "The old smartTagging-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedSmartTagging",
"type": "object"
},
"GeneralSettingsModifiedSubjectExtractionType": {
"properties": {
"newSubjectExtractionType": {
"description": "The new subjectExtractionType.",
"enum": [
"FileName",
"Headline",
"Title"
],
"example": "FileName",
"title": "SubjectExtractionType",
"type": "string"
},
"oldSubjectExtractionType": {
"description": "The old subjectExtractionType.",
"enum": [
"FileName",
"Headline",
"Title"
],
"example": "FileName",
"title": "SubjectExtractionType",
"type": "string"
}
},
"title": "GeneralSettingsModifiedSubjectExtractionType",
"type": "object"
},
"GeneralSettingsModifiedSystemLanguage": {
"properties": {
"newSystemLanguage": {
"description": "The old systemLanguage-flag.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldSystemLanguage": {
"description": "The old systemLanguage-flag.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "GeneralSettingsModifiedSystemLanguage",
"type": "object"
},
"GeneralSettingsModifiedTextRecognition": {
"properties": {
"newTextRecognition": {
"description": "The new TextRecognition-flag.",
"type": "boolean"
},
"oldTextRecognition": {
"description": "The old TextRecognition-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedTextRecognition",
"type": "object"
},
"GeneralSettingsModifiedTranslationLanguagesAdded": {
"properties": {
"translationLanguagesAdded": {
"$ref": "#/components/schemas/ArraySchema_3439356330"
}
},
"title": "GeneralSettingsModifiedTranslationLanguagesAdded",
"type": "object"
},
"GeneralSettingsModifiedTranslationLanguagesRemoved": {
"properties": {
"translationLanguagesRemoved": {
"$ref": "#/components/schemas/ArraySchema_6465306239"
}
},
"title": "GeneralSettingsModifiedTranslationLanguagesRemoved",
"type": "object"
},
"GeneralSettingsModifiedTwoFactorAuth": {
"properties": {
"newTwoFactorAuth": {
"description": "The new twoFactorAuth-flag.",
"type": "boolean"
},
"oldTwoFactorAuth": {
"description": "The old twoFactorAuth-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedTwoFactorAuth",
"type": "object"
},
"GeneralSettingsModifiedUseAlreadyIncludedKeywords": {
"properties": {
"newUseAlreadyIncludedKeywords": {
"description": "The old useAlreadyIncludedKeywords-flag.",
"type": "boolean"
},
"oldUseAlreadyIncludedKeywords": {
"description": "The old useAlreadyIncludedKeywords-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedUseAlreadyIncludedKeywords",
"type": "object"
},
"GeneralSettingsModifiedVideoForceConversion": {
"properties": {
"newVideoForceConversion": {
"description": "The new videoForceConversion-flag.",
"type": "boolean"
},
"oldVideoForceConversion": {
"description": "The old videoForceConversion-flag.",
"type": "boolean"
}
},
"title": "GeneralSettingsModifiedVideoForceConversion",
"type": "object"
},
"GeneralSettingsModifiedVideoMaxDuration": {
"properties": {
"newVideoMaxDurationSeconds": {
"description": "The new videoMaxDuration in seconds.",
"type": "integer"
},
"oldVideoMaxDurationSeconds": {
"description": "The old videoMaxDuration in seconds.",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedVideoMaxDuration",
"type": "object"
},
"GeneralSettingsModifiedVideoMaxSize": {
"properties": {
"newVideoMaxSize": {
"description": "The new videoMaxSize.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"oldVideoMaxSize": {
"description": "The old videoMaxSize.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "GeneralSettingsModifiedVideoMaxSize",
"type": "object"
},
"IdentityProviderModifiedAuthorizationEndpoint": {
"properties": {
"newAuthorizationEndpoint": {
"description": "The new authorizationEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldAuthorizationEndpoint": {
"description": "The old authorizationEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "IdentityProviderModifiedAuthorizationEndpoint",
"type": "object"
},
"IdentityProviderModifiedClientID": {
"properties": {
"newClientID": {
"description": "The new clientID.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldClientID": {
"description": "The old clientID.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "IdentityProviderModifiedClientID",
"type": "object"
},
"IdentityProviderModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "IdentityProviderModifiedIsActive",
"type": "object"
},
"IdentityProviderModifiedMetadataEndpoint": {
"properties": {
"newMetadataEndpoint": {
"description": "The new metadataEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldMetadataEndpoint": {
"description": "The old metadataEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "IdentityProviderModifiedMetadataEndpoint",
"type": "object"
},
"IdentityProviderModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "IdentityProviderModifiedName",
"type": "object"
},
"IdentityProviderModifiedTokenEndpoint": {
"properties": {
"newTokenEndpoint": {
"description": "The new tokenEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldTokenEndpoint": {
"description": "The old tokenEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "IdentityProviderModifiedTokenEndpoint",
"type": "object"
},
"IdentityProviderModifiedUserEndpoint": {
"properties": {
"newUserEndpoint": {
"description": "The new userEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldUserEndpoint": {
"description": "The old userEndpoint.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "IdentityProviderModifiedUserEndpoint",
"type": "object"
},
"IdentityProviderModifiedUserField": {
"properties": {
"newUserField": {
"description": "The new userField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldUserField": {
"description": "The old userField.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "IdentityProviderModifiedUserField",
"type": "object"
},
"ImportantMetadata": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDeleted": {
"type": "boolean"
},
"isEditable": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "ImportantMetadata",
"type": "object"
},
"ImportantMetadataModifiedIsEditable": {
"properties": {
"newIsEditable": {
"description": "The new iseditable.",
"type": "boolean"
},
"oldIsEditable": {
"description": "The old iseditable.",
"type": "boolean"
}
},
"title": "ImportantMetadataModifiedIsEditable",
"type": "object"
},
"ImportantMetadataModifiedIsIndexed": {
"properties": {
"newIsIndexed": {
"description": "The new isindexed.",
"type": "boolean"
},
"oldIsIndexed": {
"description": "The old isindexed.",
"type": "boolean"
}
},
"title": "ImportantMetadataModifiedIsIndexed",
"type": "object"
},
"ImportantMetadataModifiedOrder": {
"properties": {
"newOrder": {
"description": "The new order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "The old order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ImportantMetadataModifiedOrder",
"type": "object"
},
"InternalMetadata": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isEditable": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "InternalMetadata",
"type": "object"
},
"Job": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"error": {
"type": "string"
},
"finishedJobData": {
"description": "The data of the finished job.\n\t\t\u003cstrong\u003eNote:\u003c/strong\u003e Not defined if the job has been finished or the jobType does not have any jobData.",
"oneOf": [
{
"properties": {
"filesDelete": {
"$ref": "#/components/schemas/FilesDelete"
}
},
"type": "object"
},
{
"properties": {
"filesDownload": {
"$ref": "#/components/schemas/FilesDownload"
}
},
"type": "object"
},
{
"properties": {
"filesModify": {
"$ref": "#/components/schemas/FilesModify"
}
},
"type": "object"
},
{
"properties": {
"filesReplacePreviewFile": {
"$ref": "#/components/schemas/FilesReplacePreviewFile"
}
},
"type": "object"
},
{
"properties": {
"filesUpload": {
"$ref": "#/components/schemas/FilesUpload"
}
},
"type": "object"
}
]
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isFinished": {
"type": "boolean"
},
"isStarted": {
"type": "boolean"
},
"jobType": {
"description": "A message queue job type.",
"enum": [
"createCollection",
"createCustomMetadata",
"createDirectLink",
"createFile",
"createKeywordsFileUpload",
"createVariantStack",
"deleteCollections",
"deleteCustomMetadata",
"deleteTrash",
"deleteUser",
"downloadFiles",
"files",
"filesDelete",
"filesPut",
"keywords",
"keywordsV1",
"metadataFieldsPut",
"moveDirectory",
"replacePreviewFiles",
"restoreTrash",
"synonyms",
"transferUser",
"updateCollections",
"updateCustomMetadata",
"updateStandardMetadata",
"uploadDesignFile",
"uploadDesignFiles",
"uploadLicenseReleaseFile",
"uploadModelReleaseFile",
"uploadPortalDesignFiles",
"uploadPropertyReleaseFile",
"uploadSpaceDesignFiles",
"uploadWatermarkFile",
"userSync"
],
"example": "keywords",
"title": "MessageQueueJobType",
"type": "string"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"percent": {
"description": "percent is a number between 0 and 100",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
},
"success": {
"type": "boolean"
}
},
"title": "Job",
"type": "object"
},
"Keyword": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"permissionGroups": {
"items": {
"$ref": "#/components/schemas/PermissionGroupBasic"
},
"type": "array"
}
},
"title": "Keyword",
"type": "object"
},
"KeywordModifiedPermissionGroupIDsAdded": {
"properties": {
"permissionGroupIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6432616539"
}
},
"title": "KeywordModifiedPermissionGroupIDsAdded",
"type": "object"
},
"KeywordModifiedPermissionGroupIDsRemoved": {
"properties": {
"permissionGroupIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3539653435"
}
},
"title": "KeywordModifiedPermissionGroupIDsRemoved",
"type": "object"
},
"License": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseBasic"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"provider": {
"type": "string"
}
},
"title": "License",
"type": "object"
},
"LicenseBasic": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"provider": {
"type": "string"
}
},
"title": "LicenseBasic",
"type": "object"
},
"LicenseData": {
"description": "A license data",
"example": {
"name": "license name",
"value": "license value"
},
"properties": {
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"value": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseData",
"type": "object"
},
"LicenseFileInfo": {
"description": "The info about a download format.",
"example": {
"expirationDate": "2024-12-31 23:59:59",
"id": 5,
"name": "Instagram"
},
"properties": {
"expirationDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseFileInfo",
"type": "object"
},
"LicenseFileModifiedColor": {
"properties": {
"newColor": {
"description": "The new color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldColor": {
"description": "The old color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "LicenseFileModifiedColor",
"type": "object"
},
"LicenseFileModifiedCreateDate": {
"properties": {
"newCreateDate": {
"description": "The new createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldCreateDate": {
"description": "The old createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "LicenseFileModifiedCreateDate",
"type": "object"
},
"LicenseFileModifiedInfosAdded": {
"properties": {
"infosAdded": {
"$ref": "#/components/schemas/ArraySchema_3463653235"
}
},
"title": "LicenseFileModifiedInfosAdded",
"type": "object"
},
"LicenseFileModifiedInfosRemoved": {
"properties": {
"infosRemoved": {
"$ref": "#/components/schemas/ArraySchema_3930653232"
}
},
"title": "LicenseFileModifiedInfosRemoved",
"type": "object"
},
"LicenseFileModifiedShowFile": {
"properties": {
"newShowFile": {
"description": "The new showFile-flag.",
"type": "boolean"
},
"oldShowFile": {
"description": "The old showFile-flag.",
"type": "boolean"
}
},
"title": "LicenseFileModifiedShowFile",
"type": "object"
},
"LicenseFileModifiedShowWarningMessage": {
"properties": {
"newShowWarningMessage": {
"description": "The new showWarningMessage-flag.",
"type": "boolean"
},
"oldShowWarningMessage": {
"description": "The old showWarningMessage-flag.",
"type": "boolean"
}
},
"title": "LicenseFileModifiedShowWarningMessage",
"type": "object"
},
"LicenseFileModifiedWarningMessage": {
"properties": {
"newWarningMessage": {
"description": "The new warningMessage.",
"type": "string"
},
"oldWarningMessage": {
"description": "The old warningMessage.",
"type": "string"
}
},
"title": "LicenseFileModifiedWarningMessage",
"type": "object"
},
"LicenseFileObject": {
"example": {
"expires": "2024-01-15 17:23:22",
"id": 5
},
"properties": {
"expires": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "LicenseFileObject",
"type": "object"
},
"LicenseModifiedProvider": {
"properties": {
"newProvider": {
"description": "The new provider.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldProvider": {
"description": "The old provider.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseModifiedProvider",
"type": "object"
},
"LicenseRelease": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseData"
},
"type": "array"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"license": {
"$ref": "#/components/schemas/LicenseBasic"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"type": "string"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "LicenseRelease",
"type": "object"
},
"LicenseReleaseBasic": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseData"
},
"type": "array"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"license": {
"$ref": "#/components/schemas/LicenseBasic"
},
"name": {
"type": "string"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "LicenseReleaseBasic",
"type": "object"
},
"LicenseReleaseData": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"licenseReleaseID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"type": "string"
},
"value": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseReleaseData",
"type": "object"
},
"LicenseReleaseDataTranslationModifiedContentName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newContentName": {
"description": "The new contentName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldContentName": {
"description": "The old contentName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseReleaseDataTranslationModifiedContentName",
"type": "object"
},
"LicenseReleaseDataTranslationModifiedContentValue": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newContentValue": {
"description": "The new contentvalue.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldContentValue": {
"description": "The old contentvalue.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseReleaseDataTranslationModifiedContentValue",
"type": "object"
},
"LicenseReleaseDataTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "LicenseReleaseDataTranslationModifiedLanguage",
"type": "object"
},
"LicenseReleaseForFile": {
"properties": {
"expires": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"licenseRelease": {
"$ref": "#/components/schemas/LicenseReleaseBasic"
}
},
"title": "LicenseReleaseForFile",
"type": "object"
},
"LicenseReleaseTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "LicenseReleaseTranslationModifiedLanguage",
"type": "object"
},
"LicenseReleaseTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "LicenseReleaseTranslationModifiedName",
"type": "object"
},
"Location": {
"description": "A location with latitude, longitude and address.",
"example": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
},
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "Location",
"type": "object"
},
"LocationFilter": {
"description": "A filter for locations.",
"example": {
"latitude": 41.84201,
"longitude": -89.485937,
"radius": 100
},
"properties": {
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
},
"radius": {
"description": "PositiveFloat is a positive floating-point number, i.e. a number with a value \u003e 0 (must not be equal to 0).",
"example": 12.5,
"title": "PositiveFloat",
"type": "number"
}
},
"title": "LocationFilter",
"type": "object"
},
"LocationForFile": {
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "LocationForFile",
"type": "object"
},
"Location_3064313965": {
"description": "The old metadataFieldLocation.",
"example": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
},
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "Location",
"type": "object"
},
"Location_3537306532": {
"description": "The new metadataFieldLocation.",
"example": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
},
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "Location",
"type": "object"
},
"Location_3739346466": {
"description": "The old location.",
"example": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
},
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "Location",
"type": "object"
},
"Location_3962616263": {
"description": "The new location.",
"example": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
},
"properties": {
"address": {
"type": "string"
},
"latitude": {
"description": "The latitude of the location, where the file was created.",
"example": 37.629562,
"maximum": 90,
"minimum": -90,
"title": "Latitude",
"type": "number"
},
"longitude": {
"description": "The longitude of the location where the file was created.",
"example": -116.849556,
"maximum": 180,
"minimum": -180,
"title": "Longitude",
"type": "number"
}
},
"title": "Location",
"type": "object"
},
"LoginAttempted": {
"properties": {
"ipAddress": {
"description": "The ipAddress.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"successful": {
"description": "The flag indicates if the login was successful.",
"type": "boolean"
},
"userName": {
"description": "The userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "LoginAttempted",
"type": "object"
},
"ManageAdministrationServerModifiedAdministrationServerIdentifier": {
"properties": {
"newAdministrationServerIdentifier": {
"description": "The new administrationServerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldAdministrationServerIdentifier": {
"description": "The old administrationServerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageAdministrationServerModifiedAdministrationServerIdentifier",
"type": "object"
},
"ManageAdministrationServerModifiedAllowsPushConnection": {
"properties": {
"newAllowsPushConnection": {
"description": "The new allowsPushConnection-flag.",
"type": "boolean"
},
"oldAllowsPushConnection": {
"description": "The old allowsPushConnection-flag.",
"type": "boolean"
}
},
"title": "ManageAdministrationServerModifiedAllowsPushConnection",
"type": "object"
},
"ManageAdministrationServerModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ManageAdministrationServerModifiedName",
"type": "object"
},
"ManageAdministrationServerModifiedURL": {
"properties": {
"newURL": {
"description": "The new URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldURL": {
"description": "The old URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "ManageAdministrationServerModifiedURL",
"type": "object"
},
"ManageApplicationKeyModifiedCustomerIdentifier": {
"properties": {
"newCustomerIdentifier": {
"description": "The new customerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldCustomerIdentifier": {
"description": "The old customerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageApplicationKeyModifiedCustomerIdentifier",
"type": "object"
},
"ManageApplicationKeyModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "ManageApplicationKeyModifiedIsActive",
"type": "object"
},
"ManageApplicationKeyModifiedKey": {
"properties": {
"newApplicationKey": {
"description": "The new applicationKey.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldApplicationKey": {
"description": "The old applicationKey.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageApplicationKeyModifiedKey",
"type": "object"
},
"ManageApplicationKeyModifiedName": {
"properties": {
"newName": {
"description": "The new applicationName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old applicationName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ManageApplicationKeyModifiedName",
"type": "object"
},
"ManageApplicationKeyModifiedUnlockedUniversal": {
"properties": {
"newUnlockedUniversal": {
"description": "The new unlockedUniversal-flag.",
"type": "boolean"
},
"oldUnlockedUniversal": {
"description": "The old unlockedUniversal-flag.",
"type": "boolean"
}
},
"title": "ManageApplicationKeyModifiedUnlockedUniversal",
"type": "object"
},
"ManageBatchTenant": {
"properties": {
"operations": {
"$ref": "#/components/schemas/ArraySchema_3864613737"
},
"tenant_id": {
"description": "The tenant ID of the index tenant.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"total_file_count": {
"description": "The total file count to process for the index tenant.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManageBatchTenant",
"type": "object"
},
"ManageHostModifiedHostName": {
"properties": {
"newHostName": {
"description": "The new hostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldHostName": {
"description": "The old hostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "ManageHostModifiedHostName",
"type": "object"
},
"ManageHostModifiedHostType": {
"properties": {
"newHostType": {
"description": "The new hostType-flag.",
"enum": [
"portal",
"space",
"tenant"
],
"example": "space",
"title": "HostType",
"type": "string"
},
"oldHostType": {
"description": "The old hostType-flag.",
"enum": [
"portal",
"space",
"tenant"
],
"example": "space",
"title": "HostType",
"type": "string"
}
},
"title": "ManageHostModifiedHostType",
"type": "object"
},
"ManageHostModifiedSystemIdentifier": {
"properties": {
"newSystemIdentifier": {
"description": "The new systemIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldSystemIdentifier": {
"description": "The old systemIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageHostModifiedSystemIdentifier",
"type": "object"
},
"ManagePackageModifiedAvailablePluginsAdded": {
"properties": {
"availablePluginsAdded": {
"$ref": "#/components/schemas/ArraySchema_6565326330"
}
},
"title": "ManagePackageModifiedAvailablePluginsAdded",
"type": "object"
},
"ManagePackageModifiedAvailablePluginsRemoved": {
"properties": {
"availablePluginsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3633623139"
}
},
"title": "ManagePackageModifiedAvailablePluginsRemoved",
"type": "object"
},
"ManagePackageModifiedBookingEnabled": {
"properties": {
"newBookingEnabled": {
"description": "The new bookingEnabled-flag.",
"type": "boolean"
},
"oldBookingEnabled": {
"description": "The old bookingEnabled-flag.",
"type": "boolean"
}
},
"title": "ManagePackageModifiedBookingEnabled",
"type": "object"
},
"ManagePackageModifiedCustomerValue": {
"properties": {
"newCustomerValue": {
"description": "The new customerValue.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldCustomerValue": {
"description": "The old customerValue.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedCustomerValue",
"type": "object"
},
"ManagePackageModifiedDailyAPILimit": {
"properties": {
"newDailyAPILimit": {
"description": "The new dailyAPILimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldDailyAPILimit": {
"description": "The old dailyAPILimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedDailyAPILimit",
"type": "object"
},
"ManagePackageModifiedDiskSpacePerUser": {
"properties": {
"newDiskSpacePerUser": {
"description": "The new diskSpacePerUser.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldDiskSpacePerUser": {
"description": "The old diskSpacePerUser.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedDiskSpacePerUser",
"type": "object"
},
"ManagePackageModifiedFeatures": {
"properties": {
"featuresAdded": {
"$ref": "#/components/schemas/ArraySchema_3035326536"
},
"featuresRemoved": {
"$ref": "#/components/schemas/ArraySchema_3035326536"
}
},
"title": "ManagePackageModifiedFeatures",
"type": "object"
},
"ManagePackageModifiedHideAllPackages": {
"properties": {
"newHideAllPackages": {
"description": "The new hideAllPackages-flag.",
"type": "boolean"
},
"oldHideAllPackages": {
"description": "The old hideAllPackages-flag.",
"type": "boolean"
}
},
"title": "ManagePackageModifiedHideAllPackages",
"type": "object"
},
"ManagePackageModifiedHideCustomerGroupPackages": {
"properties": {
"newHideCustomerGroupPackages": {
"description": "The new hideCustomerGroupPackages-flag.",
"type": "boolean"
},
"oldHideCustomerGroupPackages": {
"description": "The old hideCustomerGroupPackages-flag.",
"type": "boolean"
}
},
"title": "ManagePackageModifiedHideCustomerGroupPackages",
"type": "object"
},
"ManagePackageModifiedHideUniversalPackages": {
"properties": {
"newHideUniversalPackages": {
"description": "The new hideUniversalPackages-flag.",
"type": "boolean"
},
"oldHideUniversalPackages": {
"description": "The old hideUniversalPackages-flag.",
"type": "boolean"
}
},
"title": "ManagePackageModifiedHideUniversalPackages",
"type": "object"
},
"ManagePackageModifiedIncludedDiskspace": {
"properties": {
"newIncludedDiskspace": {
"description": "The new includedDiskspace.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldIncludedDiskspace": {
"description": "The old includedDiskspace.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedIncludedDiskspace",
"type": "object"
},
"ManagePackageModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ManagePackageModifiedName",
"type": "object"
},
"ManagePackageModifiedPluginLimit": {
"properties": {
"newPluginLimit": {
"description": "The new pluginLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldPluginLimit": {
"description": "The old pluginLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedPluginLimit",
"type": "object"
},
"ManagePackageModifiedSecondAPILimit": {
"properties": {
"newSecondAPILimit": {
"description": "The new secondAPILimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldSecondAPILimit": {
"description": "The old secondAPILimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"title": "ManagePackageModifiedSecondAPILimit",
"type": "object"
},
"ManagePackageModifiedUnlockedCustomerGroupsAdded": {
"properties": {
"unlockedCustomerGroupsAdded": {
"$ref": "#/components/schemas/ArraySchema_3261663434"
}
},
"title": "ManagePackageModifiedUnlockedCustomerGroupsAdded",
"type": "object"
},
"ManagePackageModifiedUnlockedCustomerGroupsRemoved": {
"properties": {
"unlockedCustomerGroupsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6266633261"
}
},
"title": "ManagePackageModifiedUnlockedCustomerGroupsRemoved",
"type": "object"
},
"ManagePackageModifiedUnlockedSystemIdentifiersAdded": {
"properties": {
"unlockedSystemIdentifiersAdded": {
"$ref": "#/components/schemas/ArraySchema_3336323230"
}
},
"title": "ManagePackageModifiedUnlockedSystemIdentifiersAdded",
"type": "object"
},
"ManagePackageModifiedUnlockedSystemIdentifiersRemoved": {
"properties": {
"unlockedSystemIdentifiersRemoved": {
"items": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"type": "array"
}
},
"title": "ManagePackageModifiedUnlockedSystemIdentifiersRemoved",
"type": "object"
},
"ManagePackageModifiedUnlockedUniversal": {
"properties": {
"newUnlockedUniversal": {
"description": "The new unlockedUniversal-flag.",
"type": "boolean"
},
"oldUnlockedUniversal": {
"description": "The old unlockedUniversal-flag.",
"type": "boolean"
}
},
"title": "ManagePackageModifiedUnlockedUniversal",
"type": "object"
},
"ManagePortalPackageModifiedFeatures": {
"properties": {
"featuresAdded": {
"$ref": "#/components/schemas/ArraySchema_3035326536"
},
"featuresRemoved": {
"$ref": "#/components/schemas/ArraySchema_3035326536"
}
},
"title": "ManagePortalPackageModifiedFeatures",
"type": "object"
},
"ManagePortalPackageModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ManagePortalPackageModifiedName",
"type": "object"
},
"ManageServerRecreateConfig": {
"properties": {
"duration": {
"description": "The duration.",
"example": "1 s",
"title": "Duration",
"type": "string"
}
},
"title": "ManageServerRecreateConfig",
"type": "object"
},
"ManageServerReload": {
"properties": {
"duration": {
"description": "The duration.",
"example": "1 s",
"title": "Duration",
"type": "string"
}
},
"title": "ManageServerReload",
"type": "object"
},
"ManageSystemCreated": {
"properties": {
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemCreated",
"type": "object"
},
"ManageSystemDeleted": {
"properties": {
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemDeleted",
"type": "object"
},
"ManageSystemModifiedAdditionalDiskSpaceGigaByte": {
"properties": {
"newAdditionalDiskSpaceGigaByte": {
"description": "The new additionalDiskSpaceGigaByte.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldAdditionalDiskSpaceGigaByte": {
"description": "The old additionalDiskSpaceGigaByte.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedAdditionalDiskSpaceGigaByte",
"type": "object"
},
"ManageSystemModifiedAdministrationServerIdentifier": {
"properties": {
"newAdministrationServerIdentifier": {
"description": "The new administrationServerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldAdministrationServerIdentifier": {
"description": "The old administrationServerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedAdministrationServerIdentifier",
"type": "object"
},
"ManageSystemModifiedCustomerGroupsAdded": {
"properties": {
"customerGroupsAdded": {
"$ref": "#/components/schemas/ArraySchema_6239396635"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedCustomerGroupsAdded",
"type": "object"
},
"ManageSystemModifiedCustomerGroupsRemoved": {
"properties": {
"customerGroupsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6639353132"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedCustomerGroupsRemoved",
"type": "object"
},
"ManageSystemModifiedCustomerIdentifier": {
"properties": {
"newCustomerIdentifier": {
"description": "The new customerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldCustomerIdentifier": {
"description": "The old customerIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedCustomerIdentifier",
"type": "object"
},
"ManageSystemModifiedDataPath": {
"properties": {
"newDataPath": {
"description": "The new dataPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"oldDataPath": {
"description": "The old dataPath.",
"example": "/path/to/file",
"title": "Path",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedDataPath",
"type": "object"
},
"ManageSystemModifiedDatabaseAlias": {
"properties": {
"newDatabaseAlias": {
"description": "The new DatabaseAlias.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldDatabaseAlias": {
"description": "The old DatabaseAlias.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedDatabaseAlias",
"type": "object"
},
"ManageSystemModifiedDomainName": {
"properties": {
"newDomainName": {
"description": "The new domainName.",
"example": "io",
"title": "DomainName",
"type": "string"
},
"oldDomainName": {
"description": "The old domainName.",
"example": "io",
"title": "DomainName",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedDomainName",
"type": "object"
},
"ManageSystemModifiedExpirationDate": {
"properties": {
"newExpirationDate": {
"description": "The new expirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldExpirationDate": {
"description": "The old expirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedExpirationDate",
"type": "object"
},
"ManageSystemModifiedHostName": {
"properties": {
"newHostName": {
"description": "The new hostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldHostName": {
"description": "The old hostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedHostName",
"type": "object"
},
"ManageSystemModifiedInstallationType": {
"properties": {
"newInstallationType": {
"description": "The new installationType.",
"enum": [
"box",
"dev",
"server",
"testsystem",
"virtserver"
],
"example": "virtserver",
"title": "InstallationType",
"type": "string"
},
"oldInstallationType": {
"description": "The old installationType.",
"enum": [
"box",
"dev",
"server",
"testsystem",
"virtserver"
],
"example": "virtserver",
"title": "InstallationType",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedInstallationType",
"type": "object"
},
"ManageSystemModifiedIsCurrentlyUpdating": {
"properties": {
"newIsCurrentlyUpdating": {
"description": "The new isCurrentlyUpdating-flag.",
"type": "boolean"
},
"oldIsCurrentlyUpdating": {
"description": "The old isCurrentlyUpdating-flag.",
"type": "boolean"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedIsCurrentlyUpdating",
"type": "object"
},
"ManageSystemModifiedIsPaused": {
"properties": {
"newIsPaused": {
"description": "The new isPaused.",
"type": "boolean"
},
"oldIsPaused": {
"description": "The old isPaused.",
"type": "boolean"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedIsPaused",
"type": "object"
},
"ManageSystemModifiedLastSentMail": {
"properties": {
"newLastSentMail": {
"description": "The new lastSentMail.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldLastSentMail": {
"description": "The old lastSentMail.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedLastSentMail",
"type": "object"
},
"ManageSystemModifiedMediaPortalLimit": {
"properties": {
"newMediaPortalLimit": {
"$ref": "#/components/schemas/ObjectSchema_3665333539"
},
"oldMediaPortalLimit": {
"$ref": "#/components/schemas/ObjectSchema_3232663839"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedMediaPortalLimit",
"type": "object"
},
"ManageSystemModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedName",
"type": "object"
},
"ManageSystemModifiedOperatingSystem": {
"properties": {
"newOperatingSystem": {
"description": "The new operatingSystem.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOperatingSystem": {
"description": "The old operatingSystem.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedOperatingSystem",
"type": "object"
},
"ManageSystemModifiedPixxioVersion": {
"properties": {
"newPixxioVersion": {
"description": "The new pixxioVersion.",
"example": "2.1.3",
"title": "PixxioVersion",
"type": "string"
},
"oldPixxioVersion": {
"description": "The old pixxioVersion.",
"example": "2.1.3",
"title": "PixxioVersion",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedPixxioVersion",
"type": "object"
},
"ManageSystemModifiedReadOnlyUserLimit": {
"properties": {
"newReadOnlyUserLimit": {
"description": "The new readOnlyUserLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldReadOnlyUserLimit": {
"description": "The old readOnlyUserLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedReadOnlyUserLimit",
"type": "object"
},
"ManageSystemModifiedReceiveBetaUpdates": {
"properties": {
"newReceiveBetaUpdates": {
"description": "The new receiveBetaUpdates-flag.",
"type": "boolean"
},
"oldReceiveBetaUpdates": {
"description": "The old receiveBetaUpdates-flag.",
"type": "boolean"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedReceiveBetaUpdates",
"type": "object"
},
"ManageSystemModifiedReceiveUpdates": {
"properties": {
"newReceiveUpdates": {
"description": "The new receiveUpdates-flag.",
"type": "boolean"
},
"oldReceiveUpdates": {
"description": "The old receiveUpdates-flag.",
"type": "boolean"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedReceiveUpdates",
"type": "object"
},
"ManageSystemModifiedSQLDatabase": {
"properties": {
"newSQLDatabase": {
"description": "The new SQLDatabase.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSQLDatabase": {
"description": "The old SQLDatabase.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSQLDatabase",
"type": "object"
},
"ManageSystemModifiedSQLHost": {
"properties": {
"newSQLHost": {
"description": "The new SQLHost.",
"example": "www.google.com",
"title": "Host",
"type": "string"
},
"oldSQLHost": {
"description": "The old SQLHost.",
"example": "www.google.com",
"title": "Host",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSQLHost",
"type": "object"
},
"ManageSystemModifiedSQLPassword": {
"properties": {
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSQLPassword",
"type": "object"
},
"ManageSystemModifiedSQLUserName": {
"properties": {
"newSQLUserName": {
"description": "The new SQLUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldSQLUserName": {
"description": "The old SQLUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSQLUserName",
"type": "object"
},
"ManageSystemModifiedSolrBaseCore": {
"properties": {
"newSolrBaseCore": {
"description": "The new SolrBaseCore.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSolrBaseCore": {
"description": "The old SolrBaseCore.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSolrBaseCore",
"type": "object"
},
"ManageSystemModifiedSolrOrigin": {
"properties": {
"newSolrOrigin": {
"description": "The new SolrOrigin.",
"example": "https://www.google.com:443",
"title": "Origin",
"type": "string"
},
"oldSolrOrigin": {
"description": "The old SolrOrigin.",
"example": "https://www.google.com:443",
"title": "Origin",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSolrOrigin",
"type": "object"
},
"ManageSystemModifiedSolrPassword": {
"properties": {
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSolrPassword",
"type": "object"
},
"ManageSystemModifiedSolrUserName": {
"properties": {
"newSolrUserName": {
"description": "The new SolrUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldSolrUserName": {
"description": "The old SolrUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedSolrUserName",
"type": "object"
},
"ManageSystemModifiedUDID": {
"properties": {
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedUDID",
"type": "object"
},
"ManageSystemModifiedUserLimit": {
"properties": {
"newUserLimit": {
"description": "The new userLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldUserLimit": {
"description": "The old userLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageSystemModifiedUserLimit",
"type": "object"
},
"ManageUnlockedApplicationKeyModifiedRedirectURI": {
"properties": {
"newRedirectURI": {
"description": "The new redirectURI.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldRedirectURI": {
"description": "The old redirectURI.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "ManageUnlockedApplicationKeyModifiedRedirectURI",
"type": "object"
},
"ManageUnlockedApplicationKeyModifiedSystemIdentifier": {
"properties": {
"newSystemIdentifier": {
"description": "The new systemIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldSystemIdentifier": {
"description": "The old systemIdentifier.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "ManageUnlockedApplicationKeyModifiedSystemIdentifier",
"type": "object"
},
"MandatoryDefaultMetadataField": {
"description": "A mandatory default metadata field",
"example": {
"maximum": 100,
"minimum": 1,
"noticeText": "Please enter a number",
"type": "keywords"
},
"properties": {
"maximum": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"minimum": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"noticeText": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"type": {
"description": "The type of the MandatoryDefaultMetadataField",
"enum": [
"keywords",
"subject"
],
"example": "keywords",
"title": "MandatoryDefaultMetadataFieldType",
"type": "string"
}
},
"title": "MandatoryDefaultMetadataField",
"type": "object"
},
"MapOfArrayOfLanguageCode": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The languages are added to the specified metadata-field of the file. Duplicate multi-selections are not added, but no error is thrown. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"de"
]
},
"title": "MapOfArrayOfLanguageCode",
"type": "object"
},
"MapOfArrayOfLanguageCode_3835393633": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The languageCodes are removed from the specified metadata-field of the file. No error is thrown when the specified multi-selection does not exist in the specified metadata-field for the specified file(s). The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"de"
]
},
"title": "MapOfArrayOfLanguageCode",
"type": "object"
},
"MapOfArrayOfLanguageCode_6363386466": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The languageCodes are added to the specified metadata-field of the file. Duplicate multi-selections are not added, but no error is thrown. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"de"
]
},
"title": "MapOfArrayOfLanguageCode",
"type": "object"
},
"MapOfArrayOfString": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfString"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Append the text of the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"A string with any formatting"
]
},
"title": "MapOfArrayOfString",
"type": "object"
},
"MapOfArrayOfString_6232666664": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfString"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Append the text of the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"A string with any formatting"
]
},
"title": "MapOfArrayOfString",
"type": "object"
},
"MapOfArrayOfTerm": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The multi-selections are added to the specified metadata-field of the file. Duplicate multi-selections are not added, but no error is thrown. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"aaaAA"
]
},
"title": "MapOfArrayOfTerm",
"type": "object"
},
"MapOfArrayOfTerm_3332373064": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The multi-selections are removed from the specified metadata-field of the file. No error is thrown when the specified multi-selection does not exist in the specified metadata-field for the specified file(s). The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"aaaAA"
]
},
"title": "MapOfArrayOfTerm",
"type": "object"
},
"MapOfArrayOfTerm_3633363335": {
"additionalProperties": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e The multi-selections are added to the specified metadata-field of the file. Duplicate multi-selections are not added, but no error is thrown. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": [
"aaaAA"
]
},
"title": "MapOfArrayOfTerm",
"type": "object"
},
"MapOfDateTime": {
"additionalProperties": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Append the text of the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "2024-01-02 14:10:03"
},
"title": "MapOfDateTime",
"type": "object"
},
"MapOfDateTime_3561643630": {
"additionalProperties": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Append the text of the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "2024-01-02 14:10:03"
},
"title": "MapOfDateTime",
"type": "object"
},
"MapOfFocalPoint": {
"additionalProperties": {
"$ref": "#/components/schemas/FocalPoint_6433356230"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the focalPoint to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": {
"x": 0.5,
"y": 0.5
}
},
"title": "MapOfFocalPoint",
"type": "object"
},
"MapOfFocalPoint_6634373839": {
"additionalProperties": {
"$ref": "#/components/schemas/FocalPoint_6433356230"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the focalPoint to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": {
"x": 0.5,
"y": 0.5
}
},
"title": "MapOfFocalPoint",
"type": "object"
},
"MapOfLocation": {
"additionalProperties": {
"$ref": "#/components/schemas/Location"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the location to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
}
},
"title": "MapOfLocation",
"type": "object"
},
"MapOfLocation_6662343838": {
"additionalProperties": {
"$ref": "#/components/schemas/Location"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the location to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": {
"address": "325 W 2nd St, USA",
"latitude": 41.84201,
"longitude": -89.485937
}
},
"title": "MapOfLocation",
"type": "object"
},
"MapOfString": {
"additionalProperties": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the text to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "A string with any formatting"
},
"title": "MapOfString",
"type": "object"
},
"MapOfString_6431653661": {
"additionalProperties": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the text to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "A string with any formatting"
},
"title": "MapOfString",
"type": "object"
},
"MapOfTerm": {
"additionalProperties": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the selection to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "aaaAA"
},
"title": "MapOfTerm",
"type": "object"
},
"MapOfTerm_6262643138": {
"additionalProperties": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"deprecated": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eDEPRECATED use metadataCustom / metadataStandard instead\u003c/strong\u003e Write the selection to the specified metadata-field. The metadata-field is determined by the name here, and not by the ID of the metadata-fields-database-table. This is because it is also possible to write data to arbitrary fields, which are not listed in the metadata-fields-database-table.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e An error occurs when the specified metadata-field is listed in the metadata-fields-database-table and has an incompatible editType!\u003c/p\u003e \u003c/blockquote\u003e ",
"example": {
"key1": "aaaAA"
},
"title": "MapOfTerm",
"type": "object"
},
"MessageCenterModifiedCollectionsAdded": {
"properties": {
"collectionsAdded": {
"$ref": "#/components/schemas/ArraySchema_3563633032"
}
},
"title": "MessageCenterModifiedCollectionsAdded",
"type": "object"
},
"MessageCenterModifiedCollectionsRemoved": {
"properties": {
"collectionsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3336323038"
}
},
"title": "MessageCenterModifiedCollectionsRemoved",
"type": "object"
},
"MessageCenterModifiedNotificationByApplication": {
"properties": {
"newNotificationByApplication": {
"description": "The new notificationByApplication-flag.",
"type": "boolean"
},
"oldNotificationByApplication": {
"description": "The old notificationByApplication-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotificationByApplication",
"type": "object"
},
"MessageCenterModifiedNotificationByEmail": {
"properties": {
"newNotificationByEmail": {
"description": "The new notificationByEmail-flag.",
"type": "boolean"
},
"oldNotificationByEmail": {
"description": "The old notificationByEmail-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotificationByEmail",
"type": "object"
},
"MessageCenterModifiedNotificationDayTime": {
"properties": {
"newNotificationDayTime": {
"description": "The new notificationDayTime.",
"example": "12:00",
"title": "Daytime",
"type": "string"
},
"oldNotificationDayTime": {
"description": "The old notificationDayTime.",
"example": "12:00",
"title": "Daytime",
"type": "string"
}
},
"title": "MessageCenterModifiedNotificationDayTime",
"type": "object"
},
"MessageCenterModifiedNotificationInterval": {
"properties": {
"newNotificationInterval": {
"description": "The new notificationInterval.",
"enum": [
"daily",
"immediately",
"monthly",
"weekly"
],
"example": "immediately",
"title": "MessageInterval",
"type": "string"
},
"oldNotificationInterval": {
"description": "The old notificationInterval.",
"enum": [
"daily",
"immediately",
"monthly",
"weekly"
],
"example": "immediately",
"title": "MessageInterval",
"type": "string"
}
},
"title": "MessageCenterModifiedNotificationInterval",
"type": "object"
},
"MessageCenterModifiedNotificationMonthDay": {
"properties": {
"newNotificationMonthDay": {
"description": "The new notificationMonthDay.",
"example": 1,
"maximum": 31,
"minimum": 1,
"title": "Day",
"type": "integer"
},
"oldNotificationMonthDay": {
"description": "The old notificationMonthDay.",
"example": 1,
"maximum": 31,
"minimum": 1,
"title": "Day",
"type": "integer"
}
},
"title": "MessageCenterModifiedNotificationMonthDay",
"type": "object"
},
"MessageCenterModifiedNotificationWeekDay": {
"properties": {
"newNotificationWeekDay": {
"description": "The new notificationWeekDay.",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
],
"example": "Sunday",
"title": "Weekday",
"type": "string"
},
"oldNotificationWeekDay": {
"description": "The old notificationWeekDay.",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
],
"example": "Sunday",
"title": "Weekday",
"type": "string"
}
},
"title": "MessageCenterModifiedNotificationWeekDay",
"type": "object"
},
"MessageCenterModifiedNotifyCollectionDeleted": {
"properties": {
"newNotifyCollectionDeleted": {
"description": "The new notifyCollectionDeleted-flag.",
"type": "boolean"
},
"oldNotifyCollectionDeleted": {
"description": "The old notifyCollectionDeleted-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyCollectionDeleted",
"type": "object"
},
"MessageCenterModifiedNotifyCollectionEdited": {
"properties": {
"newNotifyCollectionEdited": {
"description": "The new notifyCollectionEdited-flag.",
"type": "boolean"
},
"oldNotifyCollectionEdited": {
"description": "The old notifyCollectionEdited-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyCollectionEdited",
"type": "object"
},
"MessageCenterModifiedNotifyCollectionMessagingWithoutSubscription": {
"properties": {
"newNotifyCollectionMessagingWithoutSubscription": {
"description": "The new notifyCollectionMessagingWithoutSubscription-flag.",
"type": "boolean"
},
"oldNotifyCollectionMessagingWithoutSubscription": {
"description": "The old notifyCollectionMessagingWithoutSubscription-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyCollectionMessagingWithoutSubscription",
"type": "object"
},
"MessageCenterModifiedNotifyCollectionShared": {
"properties": {
"newNotifyCollectionShared": {
"description": "The new notifyCollectionShared-flag.",
"type": "boolean"
},
"oldNotifyCollectionShared": {
"description": "The old notifyCollectionShared-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyCollectionShared",
"type": "object"
},
"MessageCenterModifiedNotifyCollectionSharedInternalWithMe": {
"properties": {
"newNotifyCollectionSharedInternalWithMe": {
"description": "The new notifyCollectionSharedInternalWithMe-flag.",
"type": "boolean"
},
"oldNotifyCollectionSharedInternalWithMe": {
"description": "The old notifyCollectionSharedInternalWithMe-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyCollectionSharedInternalWithMe",
"type": "object"
},
"MessageCenterModifiedNotifyExternalSharedCollectionOpened": {
"properties": {
"newNotifyExternalSharedCollectionOpened": {
"description": "The new notifyExternalSharedCollectionOpened-flag.",
"type": "boolean"
},
"oldNotifyExternalSharedCollectionOpened": {
"description": "The old notifyExternalSharedCollectionOpened-flag.",
"type": "boolean"
}
},
"title": "MessageCenterModifiedNotifyExternalSharedCollectionOpened",
"type": "object"
},
"Metadata": {
"example": {
"editType": "text",
"id": 1,
"isEditable": true,
"name": "Field 1",
"type": "custom",
"value": "Value 1"
},
"properties": {
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isEditable": {
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"parentCondition": {
"$ref": "#/components/schemas/CustomMetadataParentCondition"
},
"selectionOptions": {
"items": {
"$ref": "#/components/schemas/CustomMetadataSelectionOption_3732363832"
},
"type": "array"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"type": {
"enum": [
"custom",
"exif",
"internal",
"iptc",
"standard",
"xmp"
],
"example": "custom",
"title": "MetadataOption",
"type": "string"
},
"value": {
"type": "object"
}
},
"title": "Metadata",
"type": "object"
},
"MetadataField": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"indexedForSearchTerm": {
"type": "boolean"
},
"isImportant": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"selectionTerms": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"type": {
"description": "MetadataFieldType is a type for the metadata field type of a metadata field.",
"enum": [
"custom",
"exif",
"iptc",
"pixxio"
],
"example": "pixxio",
"title": "MetadataFieldType",
"type": "string"
}
},
"title": "MetadataField",
"type": "object"
},
"MetadataFieldForFile": {
"properties": {
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"isImportant": {
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"selectionTerms": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"type": {
"description": "MetadataFieldType is a type for the metadata field type of a metadata field.",
"enum": [
"custom",
"exif",
"iptc",
"pixxio"
],
"example": "pixxio",
"title": "MetadataFieldType",
"type": "string"
},
"value": {
"type": "object"
}
},
"title": "MetadataFieldForFile",
"type": "object"
},
"MetadataFieldModifiedEditType": {
"properties": {
"newEditType": {
"description": "The new editType.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"oldEditType": {
"description": "The old editType.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
}
},
"title": "MetadataFieldModifiedEditType",
"type": "object"
},
"MetadataFieldModifiedIndexedForSearchTerm": {
"properties": {
"newIndexedForSearchTerm": {
"description": "The new indexedForSearchTerm-flag.",
"type": "boolean"
},
"oldIndexedForSearchTerm": {
"description": "The old indexedForSearchTerm-flag.",
"type": "boolean"
}
},
"title": "MetadataFieldModifiedIndexedForSearchTerm",
"type": "object"
},
"MetadataFieldModifiedIsImportant": {
"properties": {
"newIsImportant": {
"description": "The new isImportant-flag.",
"type": "boolean"
},
"oldIsImportant": {
"description": "The old isImportant-flag.",
"type": "boolean"
}
},
"title": "MetadataFieldModifiedIsImportant",
"type": "object"
},
"MetadataFieldModifiedIsSearchable": {
"properties": {
"newIsSearchable": {
"description": "The new isSearchable-flag.",
"type": "boolean"
},
"oldIsSearchable": {
"description": "The old isSearchable-flag.",
"type": "boolean"
}
},
"title": "MetadataFieldModifiedIsSearchable",
"type": "object"
},
"MetadataFieldModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "MetadataFieldModifiedName",
"type": "object"
},
"MetadataFieldModifiedSelectionTermsAdded": {
"properties": {
"selectionTermsAdded": {
"$ref": "#/components/schemas/ArraySchema_6662633533"
}
},
"title": "MetadataFieldModifiedSelectionTermsAdded",
"type": "object"
},
"MetadataFieldModifiedSelectionTermsRemoved": {
"properties": {
"selectionTermsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3266363436"
}
},
"title": "MetadataFieldModifiedSelectionTermsRemoved",
"type": "object"
},
"MetadataFieldModifiedSelectionTermsRenamed": {
"properties": {
"selectionTermsRenamed": {
"$ref": "#/components/schemas/ArraySchema_3061616539"
}
},
"title": "MetadataFieldModifiedSelectionTermsRenamed",
"type": "object"
},
"MetadataFieldRenameSelectionTerm": {
"description": "A metadata field rename selection term.",
"example": {
"selectionTermNewName": "test2",
"selectionTermOldName": "test"
},
"properties": {
"selectionTermNewName": {
"type": "string"
},
"selectionTermOldName": {
"type": "string"
}
},
"title": "MetadataFieldRenameSelectionTerm",
"type": "object"
},
"MetadataObject": {
"example": {
"action": "add",
"id": 1,
"value": "value"
},
"properties": {
"action": {
"enum": [
"add",
"remove",
"replace"
],
"example": "add",
"title": "MetadataAction",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"value": {
"description": "The type of the value depends on the metadata editType.",
"type": "object"
}
},
"title": "MetadataObject",
"type": "object"
},
"Model": {
"properties": {
"birthDate": {
"description": "A date in the format of YYYY-MM-DD. The underlying time.Time value will always be set to midnight",
"example": "2024-01-01",
"title": "Date",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseBasic"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "Model",
"type": "object"
},
"ModelBasic": {
"properties": {
"birthDate": {
"description": "A date in the format of YYYY-MM-DD. The underlying time.Time value will always be set to midnight",
"example": "2024-01-01",
"title": "Date",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ModelBasic",
"type": "object"
},
"ModelFileModifiedColor": {
"properties": {
"newColor": {
"description": "The new color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldColor": {
"description": "The old color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "ModelFileModifiedColor",
"type": "object"
},
"ModelFileModifiedCreateDate": {
"properties": {
"newCreateDate": {
"description": "The new createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldCreateDate": {
"description": "The old createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "ModelFileModifiedCreateDate",
"type": "object"
},
"ModelFileModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ModelFileModifiedName",
"type": "object"
},
"ModelFileModifiedShowFile": {
"properties": {
"newShowFile": {
"description": "The new showFile-flag.",
"type": "boolean"
},
"oldShowFile": {
"description": "The old showFile-flag.",
"type": "boolean"
}
},
"title": "ModelFileModifiedShowFile",
"type": "object"
},
"ModelFileModifiedShowWarningMessage": {
"properties": {
"newShowWarningMessage": {
"description": "The new showWarningMessage-flag.",
"type": "boolean"
},
"oldShowWarningMessage": {
"description": "The old showWarningMessage-flag.",
"type": "boolean"
}
},
"title": "ModelFileModifiedShowWarningMessage",
"type": "object"
},
"ModelFileModifiedWarningMessage": {
"properties": {
"newWarningMessage": {
"description": "The new warningMessage.",
"type": "string"
},
"oldWarningMessage": {
"description": "The old warningMessage.",
"type": "string"
}
},
"title": "ModelFileModifiedWarningMessage",
"type": "object"
},
"ModelModifiedBirthDate": {
"properties": {
"newBirthDate": {
"description": "The new birthDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldBirthDate": {
"description": "The old birthDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "ModelModifiedBirthDate",
"type": "object"
},
"ModelModifiedEmail": {
"properties": {
"newEmail": {
"description": "The new email.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"oldEmail": {
"description": "The old email.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
},
"title": "ModelModifiedEmail",
"type": "object"
},
"ModelModifiedFirstName": {
"properties": {
"newFirstName": {
"description": "The new firstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldFirstName": {
"description": "The old firstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ModelModifiedFirstName",
"type": "object"
},
"ModelModifiedLastName": {
"properties": {
"newLastName": {
"description": "The new lastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldLastName": {
"description": "The old lastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ModelModifiedLastName",
"type": "object"
},
"ModelRelease": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"model": {
"$ref": "#/components/schemas/ModelBasic"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"type": "string"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "ModelRelease",
"type": "object"
},
"ModelReleaseBasic": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"model": {
"$ref": "#/components/schemas/ModelBasic"
},
"name": {
"type": "string"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "ModelReleaseBasic",
"type": "object"
},
"ModelReleaseForFile": {
"properties": {
"expires": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"modelRelease": {
"$ref": "#/components/schemas/ModelReleaseBasic"
}
},
"title": "ModelReleaseForFile",
"type": "object"
},
"ObjectSchema": {
"properties": {
"allowComments": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"allowDownloads": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"allowUpvotes": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"collectionID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"description": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"downloadFormatIDs": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
},
"emails": {
"$ref": "#/components/schemas/ArrayOfEmailLanguage_6262333231"
},
"encryptedPassword": {
"description": "An encrypted password.",
"example": "censored",
"title": "EncryptedPassword",
"type": "string"
},
"exportProof": {
"description": "A string with valid zero value \"\".\u003cbr\u003erequired if: **Caution:** required when forceExportProof is set to true for the user creating the share",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"fileDetails": {
"$ref": "#/components/schemas/ArrayOfFileDetail"
},
"fileIDs": {
"$ref": "#/components/schemas/ArrayOfID_6330323161"
},
"forceDownloadProof": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"forceWatermark": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatFree": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatPreview": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"mediaViews": {
"$ref": "#/components/schemas/ArrayOfMediaViewType"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"description": "the text in the email notification of share recipients",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"password": {
"description": "A password.",
"example": "censored",
"title": "Password",
"type": "string"
},
"preventSendingEmails": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"termsOfUse": {
"description": "displayed when the user downloads files from the share",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"validityPeriod": {
"description": "The duration until the share link expires. Defaults to one week.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ObjectSchema_3232663839": {
"additionalProperties": {
"type": "object"
},
"description": "The old mediaPortalLimit.",
"type": "object"
},
"ObjectSchema_3233386166": {
"properties": {
"confirmationToken": {
"description": "The token used for confirming double opt-in registration.",
"example": "16137175021NGjbweT600q4r",
"title": "Token",
"type": "string"
}
},
"required": [
"confirmationToken"
],
"type": "object"
},
"ObjectSchema_3333626632": {
"properties": {
"color": {
"description": "The color of the propertyRelease.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"file": {
"description": "\u003cp\u003eThe file which is assigned to the propertyRelease. The file has to have the fileExtension .pdf. This field gets only handled when the request is multipart/form-data.\u003c/p\u003e ",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "\u003cp\u003eThe name of the propertyRelease.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Do not specify the fileExtension here, the fileExtension .pdf is appended on the server. \u003cstrong\u003eOnly if parameter file is defined.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"name": {
"description": "\u003cp\u003eThe name of the propertyRelease.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e The name of the propertyRelease is unique. Specifying an already existing name will result in a permission error.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"propertyID": {
"description": "The ID of the property which the propertyRelease is assigned to. The property is considered as the parent of the propertyRelease. The propertyID of a propertyRelease cannot be changed.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"releaseCreateDate": {
"description": "The createDate of the propertyRelease itself (not the entity in the pixx.io database).\"",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "If the assigned file of the propertyRelease is accessible by all users in the mediaview. If false the file is only accessible in the property settings.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"default": false,
"description": "The flag indicates if a warning message should be set (1) or not (0).\"",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "\u003cp\u003eThe flag indicates if a warning message should be set (1) or not (0).\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Required if showWarningMessage: true.\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003erequired if: showWarningMessage == true",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"required": [
"color",
"name",
"propertyID"
],
"type": "object"
},
"ObjectSchema_3430303332": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"provider": {
"description": "a string term\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eCaution\u003c/strong\u003e: The provider of the license is unique. Specifying an already existing provider will result in a permission error.\u003c/p\u003e ",
"example": "ABC-Media",
"title": "Term",
"type": "string"
}
},
"required": [
"provider"
],
"type": "object"
},
"ObjectSchema_3431346139": {
"properties": {
"address": {
"default": "undefined",
"description": "The address of the property.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "\u003cp\u003eThe name of the property.\u003cbr\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u0026lt;\u003c/strong\u003e The name of the property is unique. Specifying an already existing name will result in a permission error.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"owner": {
"default": "undefined",
"description": "The owner of the property.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ObjectSchema_3533333531": {
"properties": {
"name": {
"description": "DirectoryName is an Entity for a DirectoryName. Illegal characters for a DirectoryBasic Name are the following: \\/:*?\"\u003c\u003e and |. Control Characters at the beginning and end of the name are removed. Control Characters inside the DirectoryBasic Name are replaced by one whitespace.",
"example": "My DirectoryBasic",
"title": "DirectoryName",
"type": "string"
},
"parentID": {
"description": "The ID of the parent directory that this new directory should be a subdirectory of.\u003cbr\u003eIn order to create a new root directory set this to `1`.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"required": [
"name",
"parentID"
],
"type": "object"
},
"ObjectSchema_3663393036": {
"properties": {
"color": {
"description": "Hex color code representing the license release.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"content": {
"$ref": "#/components/schemas/ArrayOfLicenseData_6462343030"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"file": {
"description": "\u003cp\u003eThe file which is assigned to the licenseRelease. The file has to have the fileExtension .pdf.\u003c/p\u003e ",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "Optional name for the uploaded file. File extension is automatically set to .pdf. Only if parameter file is set.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"licenseID": {
"description": "The license ID this release belongs to. Cannot be changed after creation.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the license release. Must be unique within the license.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"releaseCreateDate": {
"description": "The optional release creation date.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "Whether the assigned file should be shown in the media view.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"description": "Whether a warning message should be shown with this release.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "The warning message shown if showWarningMessage is true.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"required": [
"name",
"licenseID",
"color"
],
"type": "object"
},
"ObjectSchema_3665333539": {
"additionalProperties": {
"type": "object"
},
"description": "The new mediaPortalLimit.",
"type": "object"
},
"ObjectSchema_3763383933": {
"properties": {
"color": {
"description": "The color of the model release in HEX format (e.g., '2B9945').",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"file": {
"description": "\u003cp\u003eThe file which is assigned to the propertyRelease. The file has to have the fileExtension .pdf. This field gets only handled when the request is multipart/form-data.\u003c/p\u003e ",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "Optional. Overrides the file name of the uploaded file (without extension). Only if parameter file is set.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"modelID": {
"description": "The model ID this model release is assigned to. Required.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the model release. Must be unique within the model.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"releaseCreateDate": {
"description": "The release creation date in format yyyy-mm-dd hh:mm:ss.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "Whether the uploaded file is shown to all users in media view.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"description": "If true, a warning message must be provided.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "The warning message to display (required if showWarningMessage is true).",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"required": [
"name",
"modelID"
],
"type": "object"
},
"ObjectSchema_3931383238": {
"properties": {
"addFileNameToKeywords": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"addKeywords": {
"$ref": "#/components/schemas/ArrayOfTerm_6435303739"
},
"addSecondsToNewstamp": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"appendDescription": {
"description": "\u003cp\u003eAppend the description to the description possibly found in the metadata.\u003c/p\u003e ",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"asynchronousConversion": {
"default": true,
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003efalse\u003c/strong\u003e: The file is converted synchronous to this request. Depending on the uploaded file, this request can last seconds or even minutes for huge files. The advantage of a synchronous conversion is that the response of this request contains the ID of the new file.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003etrue\u003c/strong\u003e: The file is converted asynchronous to this request. Therefore, the request will be completed much faster. The disadvantage of this approach is that the response of this request is missing the ID of the new file. (This is because the file is inserted into the database after the conversion.)\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"clipServerName": {
"description": "The name of the file on the file server.",
"example": "TIEhL2yrlp3VlamtF4__1622453439_3460058.jpg",
"title": "FileServerName",
"type": "string"
},
"collectionIDs": {
"$ref": "#/components/schemas/ArrayOfID_3338633165"
},
"colorspace": {
"description": "The colorspace of a media file.",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"createDate": {
"description": "**default:** from metadata.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"creator": {
"description": "**default:** from metadata.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"description": {
"description": "**default:** from metadata.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"directoryID": {
"description": "The directoryID where the file is uploaded to. Default is the ID of the Home-Directory of the User performing the Request.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"downloadLocked": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"faceRecognitionDisabled": {
"description": "if the file should be excluded for face_recognition",
"example": true,
"title": "Bool",
"type": "boolean"
},
"file": {
"description": "The new file.",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "**default:** from the uploaded file.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"fileStateID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isConvertible": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"keywords": {
"$ref": "#/components/schemas/ArrayOfTerm_6263306663"
},
"keywordsBasedOnSettings": {
"$ref": "#/components/schemas/ArrayOfTerm_6238343364"
},
"keywordsRecognition": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"languageCodes": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"licenseReleases": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject_6366363236"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"metadataAppendText": {
"$ref": "#/components/schemas/MapOfArrayOfString_6232666664"
},
"metadataCustom": {
"$ref": "#/components/schemas/ArrayOfMetadataObject_6262373532"
},
"metadataDate": {
"$ref": "#/components/schemas/MapOfDateTime"
},
"metadataFocalPoint": {
"$ref": "#/components/schemas/MapOfFocalPoint"
},
"metadataLanguage": {
"$ref": "#/components/schemas/MapOfArrayOfLanguageCode"
},
"metadataLocation": {
"$ref": "#/components/schemas/MapOfLocation_6662343838"
},
"metadataMultiSelection": {
"$ref": "#/components/schemas/MapOfArrayOfTerm_3633363335"
},
"metadataSelection": {
"$ref": "#/components/schemas/MapOfTerm_6262643138"
},
"metadataStandard": {
"$ref": "#/components/schemas/ArrayOfMetadataObject"
},
"metadataText": {
"$ref": "#/components/schemas/MapOfString_6431653661"
},
"metadataToCopy": {
"$ref": "#/components/schemas/ArrayOfMetadataToCopy"
},
"migrationID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"migrationMD5Hash": {
"description": "The MD5 hash of the file.",
"example": "d41d8cd98f00b204e9800998ecf8427e",
"title": "MD5Hash",
"type": "string"
},
"modelReleases": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject_6366363236"
},
"originalFileServerName": {
"description": "The name of the file on the file server.",
"example": "TIEhL2yrlp3VlamtF4__1622453439_3460058.jpg",
"title": "FileServerName",
"type": "string"
},
"originalHeight": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"originalWidth": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"propertyReleases": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject_6366363236"
},
"rating": {
"description": "**default:** from metadata.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
},
"replaceID": {
"description": "\u003cp\u003eThe file-id to replace.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e the \u003ccode\u003ereplaceID\u003c/code\u003e has to be a file-id of a main-version\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"rotation": {
"description": "The rotation in degrees of the converted file (0, 90, 180 or 270).",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"subject": {
"description": "**default:** from metadata.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"uploadDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"uploadLinkGuestUserEmail": {
"description": "\u003e **Caution:** only valid if user is an \"uploadLinkUser\"",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"uploadLinkGuestUserName": {
"description": "\u003e **Caution:** only valid if user is an \"uploadLinkUser\"",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"variantFileID": {
"description": "\u003cp\u003eThe file to which the uploaded file is a variant to.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eIf the specified file-id is already part of a variant-stack, the uploaded file is added to that variant-stack.\u003c/p\u003e\n\u003cp\u003eIf the specified file-id is not part of a variant-stack, a new variant-stack containing the specified and the uploaded file is created.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"variantStackLinkName": {
"description": "\u003cp\u003eThe name of the link of the file to the variant-stack.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if:\u003c/strong\u003e \u003ccode\u003evariantFileID\u003c/code\u003e is set\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"versionID": {
"description": "\u003cp\u003eThe file to which the uploaded file is a version to.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eIf the specified file-id is already part of a version-stack, the uploaded file is added to that version-stack as main-version.\u003c/p\u003e\n\u003cp\u003eIf the specified file-id is not part of a version-stack, a new version-stack containing the specified and the uploaded file is created. The uploaded file will be the main-version.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e the \u003ccode\u003eversionID\u003c/code\u003e has to be a file-id of a main-version\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"required": [
"file"
],
"type": "object"
},
"ObjectSchema_6237643966": {
"properties": {
"birthDate": {
"description": "A date in the format of YYYY-MM-DD. The underlying time.Time value will always be set to midnight",
"example": "2024-01-01",
"title": "Date",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"required": [
"firstName",
"lastName"
],
"type": "object"
},
"ObjectSchema_6238386166": {
"properties": {
"azureActiveDirectoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.\u003cbr\u003e**Caution:** the email is unique",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"encryptedPassword": {
"description": "An encrypted password.",
"example": "censored",
"title": "EncryptedPassword",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"isActive": {
"default": false,
"description": "A bool with valid zero value \"false\".\u003cbr\u003eonly activated users are able to use pixx.io",
"example": true,
"title": "Bool",
"type": "boolean"
},
"language": {
"default": "de",
"description": "language",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"password": {
"description": "A password.",
"example": "censored",
"title": "Password",
"type": "string"
},
"permissionGroupIDs": {
"$ref": "#/components/schemas/ArrayOfID"
},
"refreshTokenToMigrate": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"userName": {
"description": "A Username\u003cbr\u003e**Caution:** the userName is unique",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"required": [
"userName",
"email"
],
"type": "object"
},
"ObjectSchema_6332303135": {
"properties": {
"downloadFormatIDs": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
},
"fileIDs": {
"$ref": "#/components/schemas/ArrayOfID_6330323161"
},
"hasDownloadFormatFree": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatPreview": {
"default": true,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"validityPeriod": {
"default": "twoWeeks",
"description": "The duration until the share link expires. Defaults to two weeks.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"required": [
"name",
"fileIDs"
],
"type": "object"
},
"ObjectSchema_6637356239": {
"properties": {
"addWatermark": {
"default": false,
"description": "\u003cp\u003eApply the configured Watermark and the configured WatermarkText to the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"allowUpscaling": {
"default": false,
"description": "\u003cp\u003eImagine an Input Image with the resolution 1000x1000 Pixel and the determined parameter width of 2000 Pixel. \u003cstrong\u003etrue:\u003c/strong\u003e The resolution of the output image is 2000x2000 Pixel due to Upscaling. \u003cstrong\u003efalse:\u003c/strong\u003e The resolution of the output image is still 1000x1000 Pixel.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"applyMetadata": {
"default": false,
"description": "\u003cp\u003e\u003cstrong\u003etrue:\u003c/strong\u003e The metadata in pixx.io is applied to the file, including the filename. \u003cstrong\u003efalse:\u003c/strong\u003e The metadata in pixx.io is not applied to the file. For the \u003ccode\u003edownloadType: original\u003c/code\u003e the original file is downloaded without any modification.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"colorspace": {
"default": "RGB",
"description": "\u003cp\u003eThis parameter determines the colorspace of the output file. The colorspace CMYK is invalid for the fileExtension png.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND NOT (\u003ccode\u003efileExtension: png\u003c/code\u003e AND \u003ccode\u003ecolorspace: CMYK\u003c/code\u003e)\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
},
"crop": {
"$ref": "#/components/schemas/CropSector"
},
"density": {
"default": 72,
"description": "\u003cp\u003eDetermines the density of the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
},
"directLinkCreationAsync": {
"default": false,
"description": "\u003cp\u003eCreate the directLink asynchronously. The response contains a jobID in that case.\u003c/p\u003e \u003cbr\u003edefault: `false`",
"example": true,
"title": "Bool",
"type": "boolean"
},
"downloadFormatID": {
"description": "\u003cp\u003eThe ID of the download format.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eRequired if\u003c/strong\u003e \u003ccode\u003edownloadType: downloadFormat\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003erequired if: downloadType == \"downloadFormat\"",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"downloadProof": {
"description": "The downloadProof.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"downloadType": {
"default": "original",
"description": "\u003cp\u003e\u003cstrong\u003eoriginal:\u003c/strong\u003e Download the original file without conversion. The file size must not exceed 1 GB for images or 5 GB for other file types. \u003cstrong\u003epreview:\u003c/strong\u003e Download the preview file without conversion. \u003cstrong\u003ecustom:\u003c/strong\u003e Converts the original file with the specified settings. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original files with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes. The original file size must not exceed 1 GB for images or 5 GB for other file types. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original file with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes. The original file size must not exceed 1 GB for images or 5 GB for other file types.\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"custom",
"downloadFormat",
"original",
"preview"
],
"example": "original",
"title": "DownloadType",
"type": "string"
},
"email": {
"description": "The email of the ExternalShareGuestUser who downloads the file.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"fileExtension": {
"default": "jpg",
"description": "\u003cp\u003eThe output file extension of the converted file for the downloadType custom.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"jpg",
"pdf",
"png",
"tiff",
"webp"
],
"example": "jpg",
"title": "DownloadDestinationFormat",
"type": "string"
},
"fileID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"fileName": {
"description": "\u003cp\u003eThe fileName of the directLink.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e The fileName of the directLink is unique. Specifying an already existing fileName will result in a permission error.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Do not specify the fileExtension here. The fileExtension is appended by the application.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"height": {
"description": "\u003cp\u003eResize the height of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"layers": {
"$ref": "#/components/schemas/ArrayOfUint"
},
"maxSize": {
"description": "\u003cp\u003eResize the long side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"minSize": {
"description": "\u003cp\u003eResize the short side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"quality": {
"default": 90,
"description": "\u003cp\u003eDetermines the quality of the output file in terms of JPG Quantization. This parameter only affects the output file for the fileExtension jpg.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND \u003ccode\u003efileExtension: jpg or webp\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"resizeFilter": {
"default": "default",
"description": "\u003cp\u003eDetermines the filter used for resizing. This parameter can impact the workload on the server what also leads to increasing performance.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"default",
"lanczos",
"mitchell"
],
"example": "default",
"title": "ResizeFilter",
"type": "string"
},
"rotation": {
"default": 0,
"description": "\u003cp\u003eRotate the output file with this parameter.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"skipCheckForceTransferOriginal": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"skipFileNameSanitization": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"stripMetadata": {
"default": false,
"description": "If true, all the metadata is stripped from the file, which can drastically reduce the fileSize.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"unit": {
"default": "px",
"description": "\u003cp\u003eDetermines the length unit for the parameter width, height, maxSize, and minSize.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
},
"useUnicodeCombiningForURL": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"userName": {
"description": "\u003cp\u003eThe userName of the ExternalShareGuestUser who downloads the file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCondition:\u003c/strong\u003e Required for ExternalShareGuestUser\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"width": {
"description": "\u003cp\u003eResize the width of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
"required": [
"fileID",
"fileName"
],
"type": "object"
},
"PermissionGroup": {
"properties": {
"activeUsersCount": {
"type": "integer"
},
"azureActiveDirectoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"directoryPermissions": {
"$ref": "#/components/schemas/PermissionGroupDirectoryPermissions"
},
"downloadFormatPermissions": {
"$ref": "#/components/schemas/PermissionGroupDownloadFormatPermissions"
},
"fileStatePermissions": {
"$ref": "#/components/schemas/PermissionGroupFileStatePermissions"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"inactiveUsersCount": {
"type": "integer"
},
"isAdmin": {
"type": "boolean"
},
"isExternal": {
"type": "boolean"
},
"isLinked": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionGroupPermissions"
},
"uploadMandatoryDefaultMetadataFields": {
"items": {
"$ref": "#/components/schemas/MandatoryDefaultMetadataField"
},
"type": "array"
},
"uploadObligations": {
"items": {
"$ref": "#/components/schemas/UploadObligation"
},
"type": "array"
},
"usersCount": {
"type": "integer"
}
},
"title": "PermissionGroup",
"type": "object"
},
"PermissionGroupBasic": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isAdmin": {
"type": "boolean"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupBasic",
"type": "object"
},
"PermissionGroupDirectoryPermissions": {
"properties": {
"editFiles": {
"$ref": "#/components/schemas/DirectoryPermissions"
},
"modify": {
"$ref": "#/components/schemas/DirectoryPermissions"
},
"showFiles": {
"$ref": "#/components/schemas/DirectoryPermissions"
},
"uploadFiles": {
"$ref": "#/components/schemas/DirectoryPermissions"
}
},
"title": "PermissionGroupDirectoryPermissions",
"type": "object"
},
"PermissionGroupDownloadFormatPermissions": {
"properties": {
"downloadFormats": {
"items": {
"$ref": "#/components/schemas/DownloadFormatBasic"
},
"type": "array"
},
"hasDownloadFormatFree": {
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"type": "boolean"
},
"hasDownloadFormatPreview": {
"type": "boolean"
},
"showAllCustomDownloadFormats": {
"type": "boolean"
}
},
"title": "PermissionGroupDownloadFormatPermissions",
"type": "object"
},
"PermissionGroupFileStatePermissions": {
"properties": {
"assignPermissions": {
"$ref": "#/components/schemas/FileStateAssignPermissions"
},
"defaultUploadFileState": {
"$ref": "#/components/schemas/FileStateBasic"
},
"showPermissions": {
"$ref": "#/components/schemas/FileStateShowPermissions"
}
},
"title": "PermissionGroupFileStatePermissions",
"type": "object"
},
"PermissionGroupInfo": {
"description": "The info of a permission group.",
"example": {
"id": 5,
"name": "Admin"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupInfo",
"type": "object"
},
"PermissionGroupModifiedCommentFiles": {
"properties": {
"newCommentFiles": {
"description": "The new commentFiles.",
"type": "boolean"
},
"oldCommentFiles": {
"description": "The old commentFiles.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedCommentFiles",
"type": "object"
},
"PermissionGroupModifiedCreateCollections": {
"properties": {
"newCreateCollections": {
"description": "The new createCollections-flag.",
"type": "boolean"
},
"oldCreateCollections": {
"description": "The old createCollections-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedCreateCollections",
"type": "object"
},
"PermissionGroupModifiedCreateKeywords": {
"properties": {
"newCreateKeywords": {
"description": "The new createKeywords-flag.",
"type": "boolean"
},
"oldCreateKeywords": {
"description": "The old createKeywords-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedCreateKeywords",
"type": "object"
},
"PermissionGroupModifiedCreatePortals": {
"properties": {
"newCreatePortals": {
"description": "The new createPortals-flag.",
"type": "boolean"
},
"oldCreatePortals": {
"description": "The old createPortals-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedCreatePortals",
"type": "object"
},
"PermissionGroupModifiedCreateUploadLinks": {
"properties": {
"newCreateUploadLinks": {
"description": "The old createUploadLinks-flag.",
"type": "boolean"
},
"oldCreateUploadLinks": {
"description": "The old createUploadLinks-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedCreateUploadLinks",
"type": "object"
},
"PermissionGroupModifiedDefaultUploadFileState": {
"properties": {
"newFileStateID": {
"description": "The old fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldFileStateID": {
"description": "The old fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupModifiedDefaultUploadFileState",
"type": "object"
},
"PermissionGroupModifiedDeleteForeignCollections": {
"properties": {
"newDeleteForeignCollections": {
"description": "The new deleteForeignCollections-flag.",
"type": "boolean"
},
"oldDeleteForeignCollections": {
"description": "The old deleteForeignCollections-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDeleteForeignCollections",
"type": "object"
},
"PermissionGroupModifiedDeleteForeignFiles": {
"properties": {
"newDeleteForeignFiles": {
"description": "The new deleteForeignFiles-flag.",
"type": "boolean"
},
"oldDeleteForeignFiles": {
"description": "The old deleteForeignFiles-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDeleteForeignFiles",
"type": "object"
},
"PermissionGroupModifiedDeleteOwnCollections": {
"properties": {
"newDeleteOwnCollections": {
"description": "The new deleteOwnCollections-flag.",
"type": "boolean"
},
"oldDeleteOwnCollections": {
"description": "The old deleteOwnCollections-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDeleteOwnCollections",
"type": "object"
},
"PermissionGroupModifiedDeleteOwnFiles": {
"properties": {
"newDeleteOwnFiles": {
"description": "The new deleteOwnFiles-flag.",
"type": "boolean"
},
"oldDeleteOwnFiles": {
"description": "The old deleteOwnFiles-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDeleteOwnFiles",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToCreateAdded": {
"properties": {
"directoryIDsToModifyAdded": {
"$ref": "#/components/schemas/ArraySchema_3833383238"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToCreateAdded",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToCreateAll": {
"properties": {
"newDirectoryIDsToModifyAll": {
"description": "The new directoryIDsToCreateAll-flag.",
"type": "boolean"
},
"oldDirectoryIDsToModifyAll": {
"description": "The old directoryIDsToCreateAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToCreateAll",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToCreateRemoved": {
"properties": {
"directoryIDsToModifyRemoved": {
"$ref": "#/components/schemas/ArraySchema_3535396365"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToCreateRemoved",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToEditAdded": {
"properties": {
"directoryIDsToEditAdded": {
"$ref": "#/components/schemas/ArraySchema_6639323131"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToEditAdded",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToEditAll": {
"properties": {
"newDirectoryIDsToEditAll": {
"description": "The new directoryIDsToEditAll-flag.",
"type": "boolean"
},
"oldDirectoryIDsToEditAll": {
"description": "The old directoryIDsToEditAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToEditAll",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToEditRemoved": {
"properties": {
"directoryIDsToEditRemoved": {
"$ref": "#/components/schemas/ArraySchema_3961363463"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToEditRemoved",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToShowAdded": {
"properties": {
"directoryIDsToShowAdded": {
"$ref": "#/components/schemas/ArraySchema_3637313131"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToShowAdded",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToShowAll": {
"properties": {
"newDirectoryIDsToShowAll": {
"description": "The new directoryIDsToShowAll-flag.",
"type": "boolean"
},
"oldDirectoryIDsToShowAll": {
"description": "The old directoryIDsToShowAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToShowAll",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToShowRemoved": {
"properties": {
"directoryIDsToShowRemoved": {
"$ref": "#/components/schemas/ArraySchema_3232376432"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToShowRemoved",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToUploadAdded": {
"properties": {
"directoryIDsToUploadAdded": {
"$ref": "#/components/schemas/ArraySchema_3164636261"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToUploadAdded",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToUploadAll": {
"properties": {
"newDirectoryIDsToUploadAll": {
"description": "The new directoryIDsToUploadAll-flag.",
"type": "boolean"
},
"oldDirectoryIDsToUploadAll": {
"description": "The old directoryIDsToUploadAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToUploadAll",
"type": "object"
},
"PermissionGroupModifiedDirectoryIDsToUploadRemoved": {
"properties": {
"directoryIDsToUploadRemoved": {
"$ref": "#/components/schemas/ArraySchema_3830326239"
}
},
"title": "PermissionGroupModifiedDirectoryIDsToUploadRemoved",
"type": "object"
},
"PermissionGroupModifiedDownloadFormatIDsAdded": {
"properties": {
"downloadFormatIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3364393438"
}
},
"title": "PermissionGroupModifiedDownloadFormatIDsAdded",
"type": "object"
},
"PermissionGroupModifiedDownloadFormatIDsRemoved": {
"properties": {
"downloadFormatIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3930336232"
}
},
"title": "PermissionGroupModifiedDownloadFormatIDsRemoved",
"type": "object"
},
"PermissionGroupModifiedEditDesign": {
"properties": {
"newEditDesign": {
"description": "The new editDesign-flag.",
"type": "boolean"
},
"oldEditDesign": {
"description": "The old editDesign-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditDesign",
"type": "object"
},
"PermissionGroupModifiedEditFilesInHomeDirectory": {
"properties": {
"newEditFilesInHomeDirectory": {
"description": "The new editFilesInHomeDirectory-flag.",
"type": "boolean"
},
"oldEditFilesInHomeDirectory": {
"description": "The old editFilesInHomeDirectory-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditFilesInHomeDirectory",
"type": "object"
},
"PermissionGroupModifiedEditFilesInInternalSharedCollections": {
"properties": {
"newEditFilesInInternalSharedCollections": {
"description": "The new editFilesInInternalSharedCollections-flag.",
"type": "boolean"
},
"oldEditFilesInInternalSharedCollections": {
"description": "The old editFilesInInternalSharedCollections-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditFilesInInternalSharedCollections",
"type": "object"
},
"PermissionGroupModifiedEditForeignCollections": {
"properties": {
"newEditForeignCollections": {
"description": "The new editForeignCollections-flag.",
"type": "boolean"
},
"oldEditForeignCollections": {
"description": "The old editForeignCollections-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditForeignCollections",
"type": "object"
},
"PermissionGroupModifiedEditForeignFiles": {
"properties": {
"newEditForeignFiles": {
"description": "The new editForeignFiles-flag.",
"type": "boolean"
},
"oldEditForeignFiles": {
"description": "The old editForeignFiles-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditForeignFiles",
"type": "object"
},
"PermissionGroupModifiedEditLicenses": {
"properties": {
"newEditLicenses": {
"description": "The new editLicenses-flag.",
"type": "boolean"
},
"oldEditLicenses": {
"description": "The old editLicenses-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditLicenses",
"type": "object"
},
"PermissionGroupModifiedEditUsers": {
"properties": {
"newEditUsers": {
"description": "The new editUsers-flag.",
"type": "boolean"
},
"oldEditUsers": {
"description": "The old editUsers-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedEditUsers",
"type": "object"
},
"PermissionGroupModifiedFileStatesToAssignAdded": {
"properties": {
"fileStatesToAssignAdded": {
"$ref": "#/components/schemas/ArraySchema_6237356466"
}
},
"title": "PermissionGroupModifiedFileStatesToAssignAdded",
"type": "object"
},
"PermissionGroupModifiedFileStatesToAssignAll": {
"properties": {
"newFileStatesToAssignAll": {
"description": "The new fileStatesToAssignAll-flag.",
"type": "boolean"
},
"oldFileStatesToAssignAll": {
"description": "The old fileStatesToAssignAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedFileStatesToAssignAll",
"type": "object"
},
"PermissionGroupModifiedFileStatesToAssignRemoved": {
"properties": {
"fileStatesToAssignRemoved": {
"$ref": "#/components/schemas/ArraySchema_3733303735"
}
},
"title": "PermissionGroupModifiedFileStatesToAssignRemoved",
"type": "object"
},
"PermissionGroupModifiedFileStatesToShowAdded": {
"properties": {
"fileStatesToShowAdded": {
"$ref": "#/components/schemas/ArraySchema_3033396164"
}
},
"title": "PermissionGroupModifiedFileStatesToShowAdded",
"type": "object"
},
"PermissionGroupModifiedFileStatesToShowAll": {
"properties": {
"newFileStatesToShowAll": {
"description": "The new fileStatesToShowAll-flag.",
"type": "boolean"
},
"oldFileStatesToShowAll": {
"description": "The old fileStatesToShowAll-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedFileStatesToShowAll",
"type": "object"
},
"PermissionGroupModifiedFileStatesToShowRemoved": {
"properties": {
"fileStatesToShowRemoved": {
"$ref": "#/components/schemas/ArraySchema_6563376663"
}
},
"title": "PermissionGroupModifiedFileStatesToShowRemoved",
"type": "object"
},
"PermissionGroupModifiedForceDownloadProof": {
"properties": {
"newForceDownloadProof": {
"description": "The new forceDownloadProof-flag.",
"type": "boolean"
},
"oldForceDownloadProof": {
"description": "The old forceDownloadProof-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedForceDownloadProof",
"type": "object"
},
"PermissionGroupModifiedForceExportProof": {
"properties": {
"newForceExportProof": {
"description": "The new forceExportProof-flag.",
"type": "boolean"
},
"oldForceExportProof": {
"description": "The old forceExportProof-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedForceExportProof",
"type": "object"
},
"PermissionGroupModifiedForceWatermark": {
"properties": {
"newForceWatermark": {
"description": "The new forceWatermark-flag.",
"type": "boolean"
},
"oldForceWatermark": {
"description": "The old forceWatermark-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedForceWatermark",
"type": "object"
},
"PermissionGroupModifiedHasDownloadFormatFree": {
"properties": {
"newHasDownloadFormatFree": {
"description": "The new hasDownloadFormatFree-flag.",
"type": "boolean"
},
"oldHasDownloadFormatFree": {
"description": "The old hasDownloadFormatFree-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedHasDownloadFormatFree",
"type": "object"
},
"PermissionGroupModifiedHasDownloadFormatOriginal": {
"properties": {
"newHasDownloadFormatOriginal": {
"description": "The new hasDownloadFormatOriginal-flag.",
"type": "boolean"
},
"oldHasDownloadFormatOriginal": {
"description": "The old hasDownloadFormatOriginal-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedHasDownloadFormatOriginal",
"type": "object"
},
"PermissionGroupModifiedHasDownloadFormatPreview": {
"properties": {
"newHasDownloadFormatPreview": {
"description": "The new hasDownloadFormatPreview-flag.",
"type": "boolean"
},
"oldHasDownloadFormatPreview": {
"description": "The old hasDownloadFormatPreview-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedHasDownloadFormatPreview",
"type": "object"
},
"PermissionGroupModifiedIsAdmin": {
"properties": {
"newIsAdmin": {
"description": "The new isAdmin-flag.",
"type": "boolean"
},
"oldIsAdmin": {
"description": "The old isAdmin-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedIsAdmin",
"type": "object"
},
"PermissionGroupModifiedIsExternal": {
"properties": {
"newIsExternal": {
"description": "The new isExternal-flag.",
"type": "boolean"
},
"oldIsExternal": {
"description": "The old isExternal-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedIsExternal",
"type": "object"
},
"PermissionGroupModifiedLinked": {
"properties": {
"id": {
"description": "The ID of the linked Identity Manager.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the linked Identity Manager.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupModifiedLinked",
"type": "object"
},
"PermissionGroupModifiedModifyDirectoriesInHomeDirectory": {
"properties": {
"newModifyDirectoriesInHomeDirectory": {
"description": "The new modifyDirectoriesInHomeDirectory-flag.",
"type": "boolean"
},
"oldModifyDirectoriesInHomeDirectory": {
"description": "The old modifyDirectoriesInHomeDirectory-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedModifyDirectoriesInHomeDirectory",
"type": "object"
},
"PermissionGroupModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupModifiedName",
"type": "object"
},
"PermissionGroupModifiedShareCollectionsExternal": {
"properties": {
"newShareCollectionsExternal": {
"description": "The new shareCollectionsExternal-flag.",
"type": "boolean"
},
"oldShareCollectionsExternal": {
"description": "The old shareCollectionsExternal-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedShareCollectionsExternal",
"type": "object"
},
"PermissionGroupModifiedShareCollectionsInternal": {
"properties": {
"newShareCollectionsInternal": {
"description": "The new shareCollectionsInternal-flag.",
"type": "boolean"
},
"oldShareCollectionsInternal": {
"description": "The old shareCollectionsInternal-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedShareCollectionsInternal",
"type": "object"
},
"PermissionGroupModifiedShareCollectionsNetwork": {
"properties": {
"newShareCollectionsNetwork": {
"description": "The new shareCollectionsNetwork-flag.",
"type": "boolean"
},
"oldShareCollectionsNetwork": {
"description": "The old shareCollectionsNetwork-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedShareCollectionsNetwork",
"type": "object"
},
"PermissionGroupModifiedShareFilesNetwork": {
"properties": {
"newShareFilesNetwork": {
"description": "The new shareFilesNetwork-flag.",
"type": "boolean"
},
"oldShareFilesNetwork": {
"description": "The old shareFilesNetwork-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedShareFilesNetwork",
"type": "object"
},
"PermissionGroupModifiedShowAllCustomDownloadFormats": {
"properties": {
"newShowAllCustomDownloadFormats": {
"description": "The new showAllCustomDownloadFormats-flag.",
"type": "boolean"
},
"oldShowAllCustomDownloadFormats": {
"description": "The old showAllCustomDownloadFormats-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedShowAllCustomDownloadFormats",
"type": "object"
},
"PermissionGroupModifiedUnlinked": {
"properties": {
"id": {
"description": "The ID of the unlinked Identity Manager.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the unlinked Identity Manager.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PermissionGroupModifiedUnlinked",
"type": "object"
},
"PermissionGroupModifiedUploadFilesToHomeDirectory": {
"properties": {
"newUploadFilesToHomeDirectory": {
"description": "The new uploadFilesToHomeDirectory-flag.",
"type": "boolean"
},
"oldUploadFilesToHomeDirectory": {
"description": "The old uploadFilesToHomeDirectory-flag.",
"type": "boolean"
}
},
"title": "PermissionGroupModifiedUploadFilesToHomeDirectory",
"type": "object"
},
"PermissionGroupModifiedUploadObligationsAdded": {
"properties": {
"uploadObligationsAdded": {
"$ref": "#/components/schemas/ArraySchema_3135343637"
}
},
"title": "PermissionGroupModifiedUploadObligationsAdded",
"type": "object"
},
"PermissionGroupModifiedUploadObligationsRemoved": {
"properties": {
"uploadObligationsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6435313162"
}
},
"title": "PermissionGroupModifiedUploadObligationsRemoved",
"type": "object"
},
"PermissionGroupPermissions": {
"properties": {
"assignFilesNoFileState": {
"type": "boolean"
},
"commentFiles": {
"type": "boolean"
},
"createCollections": {
"type": "boolean"
},
"createKeywords": {
"type": "boolean"
},
"createPortals": {
"type": "boolean"
},
"createUploadLinks": {
"type": "boolean"
},
"deleteForeignCollections": {
"type": "boolean"
},
"deleteForeignFiles": {
"type": "boolean"
},
"deleteOwnCollections": {
"type": "boolean"
},
"deleteOwnFiles": {
"type": "boolean"
},
"editDesign": {
"type": "boolean"
},
"editFaceRecognition": {
"type": "boolean"
},
"editFiles": {
"type": "boolean"
},
"editFilesInInternalSharedCollections": {
"type": "boolean"
},
"editForeignCollections": {
"type": "boolean"
},
"editForeignFiles": {
"type": "boolean"
},
"editLicenses": {
"type": "boolean"
},
"editUsers": {
"type": "boolean"
},
"forceDownloadProof": {
"type": "boolean"
},
"forceExportProof": {
"type": "boolean"
},
"forceWatermark": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"modifyDirectories": {
"type": "boolean"
},
"shareCollectionsExternal": {
"type": "boolean"
},
"shareCollectionsInternal": {
"type": "boolean"
},
"showDownloadProof": {
"type": "boolean"
},
"showExportProof": {
"type": "boolean"
},
"showFilesNoFileState": {
"type": "boolean"
},
"uploadFiles": {
"type": "boolean"
}
},
"title": "PermissionGroupPermissions",
"type": "object"
},
"PermissionGroup_6565323865": {
"description": "The permissionGroup.",
"properties": {
"activeUsersCount": {
"type": "integer"
},
"azureActiveDirectoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"directoryPermissions": {
"$ref": "#/components/schemas/PermissionGroupDirectoryPermissions"
},
"downloadFormatPermissions": {
"$ref": "#/components/schemas/PermissionGroupDownloadFormatPermissions"
},
"fileStatePermissions": {
"$ref": "#/components/schemas/PermissionGroupFileStatePermissions"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"inactiveUsersCount": {
"type": "integer"
},
"isAdmin": {
"type": "boolean"
},
"isExternal": {
"type": "boolean"
},
"isLinked": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"permissions": {
"$ref": "#/components/schemas/PermissionGroupPermissions"
},
"uploadMandatoryDefaultMetadataFields": {
"items": {
"$ref": "#/components/schemas/MandatoryDefaultMetadataField"
},
"type": "array"
},
"uploadObligations": {
"items": {
"$ref": "#/components/schemas/UploadObligation"
},
"type": "array"
},
"usersCount": {
"type": "integer"
}
},
"title": "PermissionGroup",
"type": "object"
},
"PermissionsForCollection": {
"properties": {
"delete": {
"type": "boolean"
},
"modify": {
"type": "boolean"
},
"shareExternal": {
"type": "boolean"
},
"shareInternal": {
"type": "boolean"
}
},
"title": "PermissionsForCollection",
"type": "object"
},
"PermissionsForDirectory": {
"properties": {
"delete": {
"type": "boolean"
},
"modify": {
"type": "boolean"
},
"modifyFiles": {
"type": "boolean"
},
"showFiles": {
"type": "boolean"
},
"uploadFiles": {
"type": "boolean"
}
},
"title": "PermissionsForDirectory",
"type": "object"
},
"PermissionsForFile": {
"properties": {
"checkIn": {
"type": "boolean"
},
"delete": {
"type": "boolean"
},
"download": {
"type": "boolean"
},
"modify": {
"type": "boolean"
}
},
"title": "PermissionsForFile",
"type": "object"
},
"PermissionsForFileState": {
"properties": {
"assignFiles": {
"type": "boolean"
},
"showFiles": {
"type": "boolean"
}
},
"title": "PermissionsForFileState",
"type": "object"
},
"Person": {
"description": "The person detected in an image or video.",
"example": {
"description": "The person John Doe.",
"firstName": "John",
"id": 456,
"lastName": "Doe"
},
"properties": {
"description": {
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "Person",
"type": "object"
},
"Portal": {
"properties": {
"activateUserAutomatically": {
"type": "boolean"
},
"addShadowToFont": {
"type": "boolean"
},
"automaticallyActivatedDomains": {
"items": {
"description": "A domain of an url",
"example": "www.google.com",
"title": "Domain",
"type": "string"
},
"type": "array"
},
"backgroundColor": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"brandURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"brandingLogoFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"collections": {
"items": {
"$ref": "#/components/schemas/Collection"
},
"type": "array"
},
"collectionsOrder": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"cookieButtonText": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"cookieLinkPrivacyPage": {
"type": "boolean"
},
"cookiePlacement": {
"enum": [
"bottom",
"center",
"top"
],
"example": "bottom",
"title": "PortalCookiePlacement",
"type": "string"
},
"cookieTextShort": {
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"customMetadataIDs": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"defaultMetadataFields": {
"items": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"type": "array"
},
"domainNames": {
"items": {
"description": "A domain name.",
"example": "io",
"title": "DomainName",
"type": "string"
},
"type": "array"
},
"downloadFormats": {
"items": {
"$ref": "#/components/schemas/DownloadFormatBasic"
},
"type": "array"
},
"emailReceiver": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"features": {
"items": {
"description": "A portal feature Flag.",
"enum": [
"AssetNavigator",
"Cropping",
"CustomDomain",
"DesignSettings",
"DownloadProof",
"ExternalShare",
"Password",
"SSO",
"TermsOfUseConfirmation",
"Tracking",
"TranslationLanguages",
"UserAdministration"
],
"example": "CustomDomain",
"title": "PortalFeature",
"type": "string"
},
"type": "array"
},
"filterOptions": {
"items": {
"enum": [
"languageCode"
],
"example": "languageCode",
"title": "PortalFilterType",
"type": "string"
},
"type": "array"
},
"footerText": {
"type": "string"
},
"forceDownloadProof": {
"type": "boolean"
},
"forceWatermark": {
"type": "boolean"
},
"generalPassword": {
"type": "string"
},
"hasDownloadFormatFree": {
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"type": "boolean"
},
"hasDownloadFormatPreview": {
"type": "boolean"
},
"hasGeneralPassword": {
"type": "boolean"
},
"hasUserRegistration": {
"type": "boolean"
},
"hasWhitelabel": {
"type": "boolean"
},
"heroArrowColor": {
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
},
"heroBannerFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"heroFontColor": {
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
},
"heroLogoColor": {
"enum": [
"dark",
"light"
],
"example": "light",
"title": "PortalLogoColor",
"type": "string"
},
"heroLogoFileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"heroSlogan": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"hostNames": {
"items": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"type": "array"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"landingPageOptions": {
"enum": [
"collections",
"collectionsAndFiles",
"files"
],
"example": "collectionsAndFiles",
"title": "PortalLandingPageOptions",
"type": "string"
},
"languages": {
"items": {
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"type": "array"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseBasic"
},
"type": "array"
},
"mainHostName": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"mediaViews": {
"items": {
"description": "The view type of media gallery.",
"enum": [
"HorizontalMasonry",
"SquareGallery",
"TableGallery",
"VerticalMasonry"
],
"example": "TableGallery",
"title": "MediaViewType",
"type": "string"
},
"type": "array"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseBasic"
},
"type": "array"
},
"modifiedBrandingLogoPreviewFileURLs": {
"items": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"type": "array"
},
"modifiedHeroBannerPreviewFileURLs": {
"items": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"type": "array"
},
"modifiedHeroLogoPreviewFileURLs": {
"items": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"originalDownloadFormatTypes": {
"items": {
"description": "FormatType is an Entity for a FormatType. A FormatType describes a set of FileBasic Extensions, the Web FormatType for example consists of the FileBasic Extensions JPG, JPEG, GIF and PNG.",
"enum": [
"archive",
"audio",
"converted",
"image",
"imageconverted",
"office",
"other",
"pdf",
"raw",
"raw-image",
"vector",
"video",
"web",
"web-image",
"webimage"
],
"example": "web",
"title": "FormatType",
"type": "string"
},
"type": "array"
},
"portalPackage": {
"$ref": "#/components/schemas/PortalPackageForPortal"
},
"preferredMode": {
"enum": [
"DARK",
"LIGHT",
"SYSTEM"
],
"example": "SYSTEM",
"title": "PortalDesignType",
"type": "string"
},
"preferredTitle": {
"$ref": "#/components/schemas/PortalTitleObject"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
},
"type": "array"
},
"protectedCollections": {
"items": {
"$ref": "#/components/schemas/Collection"
},
"type": "array"
},
"restrictAccess": {
"type": "boolean"
},
"searchFields": {
"items": {
"enum": [
"Creator",
"Description",
"DynamicMetadata",
"FileName",
"Keywords",
"KeywordsAuto",
"Subject",
"Synonyms",
"gpsInfo"
],
"example": "gpsInfo",
"title": "PortalSearchField",
"type": "string"
},
"type": "array"
},
"serverAliases": {
"items": {
"description": "A domain of an url",
"example": "www.google.com",
"title": "Domain",
"type": "string"
},
"type": "array"
},
"serverDomain": {
"description": "A domain of an url",
"example": "www.google.com",
"title": "Domain",
"type": "string"
},
"showAllLicenseReleases": {
"type": "boolean"
},
"showAllModelReleases": {
"type": "boolean"
},
"showAllPropertyReleases": {
"type": "boolean"
},
"showBorder": {
"type": "boolean"
},
"showCookieInformation": {
"type": "boolean"
},
"showCreateLinkToFileTab": {
"type": "boolean"
},
"showFileType": {
"type": "boolean"
},
"showLicenseReleaseFile": {
"type": "boolean"
},
"showModelReleaseFile": {
"type": "boolean"
},
"showPropertyReleaseFile": {
"type": "boolean"
},
"showStartScreen": {
"type": "boolean"
},
"sortOptions": {
"items": {
"description": "A sort type.",
"enum": [
"createDate",
"fileName",
"subject",
"uploadDate"
],
"example": "uploadDate",
"title": "SortType",
"type": "string"
},
"type": "array"
},
"standardMetadataIDs": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"startScreenText": {
"type": "string"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"useSSO": {
"type": "boolean"
},
"useSemanticSearch": {
"type": "boolean"
}
},
"title": "Portal",
"type": "object"
},
"PortalCollectionModifiedIsProtected": {
"properties": {
"collectionID": {
"description": "The ID of the modified collection.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newIsProtected": {
"description": "The new isProtected-flag.",
"type": "boolean"
},
"oldIsProtected": {
"description": "The old isProtected-flag.",
"type": "boolean"
},
"portalID": {
"description": "The ID of the modified portal.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalCollectionModifiedIsProtected",
"type": "object"
},
"PortalCollectionModifiedOrder": {
"properties": {
"collectionID": {
"description": "The ID of the modified collection.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newOrder": {
"description": "The new order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "The old order.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"portalID": {
"description": "The ID of the modified portal.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalCollectionModifiedOrder",
"type": "object"
},
"PortalModifiedActivateUserAutomatically": {
"properties": {
"newActivateUserAutomatically": {
"description": "The new activateUserAutomatically-flag.",
"type": "boolean"
},
"oldActivateUserAutomatically": {
"description": "The old activateUserAutomatically-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedActivateUserAutomatically",
"type": "object"
},
"PortalModifiedAddShadowToFont": {
"properties": {
"newAddShadowToFont": {
"description": "The new addShadowToFont-flag.",
"type": "boolean"
},
"oldAddShadowToFont": {
"description": "The old addShadowToFont-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedAddShadowToFont",
"type": "object"
},
"PortalModifiedAutomaticallyActivatedDomainsAdded": {
"properties": {
"automaticallyActivatedDomainsAdded": {
"$ref": "#/components/schemas/ArraySchema_6335373834"
}
},
"title": "PortalModifiedAutomaticallyActivatedDomainsAdded",
"type": "object"
},
"PortalModifiedAutomaticallyActivatedDomainsRemoved": {
"properties": {
"automaticallyActivatedDomainsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3231333833"
}
},
"title": "PortalModifiedAutomaticallyActivatedDomainsRemoved",
"type": "object"
},
"PortalModifiedBackgroundColor": {
"properties": {
"newBackgroundColor": {
"description": "The new backgroundColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldBackgroundColor": {
"description": "The old backgroundColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "PortalModifiedBackgroundColor",
"type": "object"
},
"PortalModifiedBrandURL": {
"properties": {
"newBrandURL": {
"description": "The new brandURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldBrandURL": {
"description": "The old brandURL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "PortalModifiedBrandURL",
"type": "object"
},
"PortalModifiedCollectionAssetNavigator": {
"properties": {
"newAssetNavigatorID": {
"description": "The new assetNavigatorID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldAssetNavigatorID": {
"description": "The old assetNavigatorID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalModifiedCollectionAssetNavigator",
"type": "object"
},
"PortalModifiedCollectionsAdded": {
"properties": {
"collectionsAdded": {
"$ref": "#/components/schemas/ArraySchema_3563633032"
}
},
"title": "PortalModifiedCollectionsAdded",
"type": "object"
},
"PortalModifiedCollectionsRemoved": {
"properties": {
"collectionsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3336323038"
}
},
"title": "PortalModifiedCollectionsRemoved",
"type": "object"
},
"PortalModifiedCookieLinkPrivacyPage": {
"properties": {
"newCookieLinkPrivacyPage": {
"description": "The new cookieLinkPrivacyPage-flag.",
"type": "boolean"
},
"oldCookieLinkPrivacyPage": {
"description": "The old cookieLinkPrivacyPage-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedCookieLinkPrivacyPage",
"type": "object"
},
"PortalModifiedCookiePlacement": {
"properties": {
"newCookiePlacement": {
"description": "The new cookiePlacement.",
"enum": [
"bottom",
"center",
"top"
],
"example": "bottom",
"title": "PortalCookiePlacement",
"type": "string"
},
"oldCookiePlacement": {
"description": "The old cookiePlacement.",
"enum": [
"bottom",
"center",
"top"
],
"example": "bottom",
"title": "PortalCookiePlacement",
"type": "string"
}
},
"title": "PortalModifiedCookiePlacement",
"type": "object"
},
"PortalModifiedCustomMetadataIDsAdded": {
"properties": {
"customMetadataIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6434353666"
}
},
"title": "PortalModifiedCustomMetadataIDsAdded",
"type": "object"
},
"PortalModifiedCustomMetadataIDsRemoved": {
"properties": {
"customMetadataIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3566303534"
}
},
"title": "PortalModifiedCustomMetadataIDsRemoved",
"type": "object"
},
"PortalModifiedDefaultMetadataFieldsAdded": {
"properties": {
"defaultmetadatafieldFieldsAdded": {
"$ref": "#/components/schemas/ArraySchema_6564633838"
}
},
"title": "PortalModifiedDefaultMetadataFieldsAdded",
"type": "object"
},
"PortalModifiedDefaultMetadataFieldsRemoved": {
"properties": {
"defaultmetadataFieldsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3838323231"
}
},
"title": "PortalModifiedDefaultMetadataFieldsRemoved",
"type": "object"
},
"PortalModifiedDownloadFormatsAdded": {
"properties": {
"downloadFormatsAdded": {
"$ref": "#/components/schemas/ArraySchema_3464386466"
}
},
"title": "PortalModifiedDownloadFormatsAdded",
"type": "object"
},
"PortalModifiedDownloadFormatsRemoved": {
"properties": {
"downloadFormatsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3434343239"
}
},
"title": "PortalModifiedDownloadFormatsRemoved",
"type": "object"
},
"PortalModifiedEmailReceiver": {
"properties": {
"newEmailReceiver": {
"description": "The new emailReceiver.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"oldEmailReceiver": {
"description": "The old emailReceiver.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
},
"title": "PortalModifiedEmailReceiver",
"type": "object"
},
"PortalModifiedFilterOptionsAdded": {
"properties": {
"filterOptionsAdded": {
"$ref": "#/components/schemas/ArraySchema_3837363038"
}
},
"title": "PortalModifiedFilterOptionsAdded",
"type": "object"
},
"PortalModifiedFilterOptionsRemoved": {
"properties": {
"filterOptionsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6430633836"
}
},
"title": "PortalModifiedFilterOptionsRemoved",
"type": "object"
},
"PortalModifiedForceDownloadProof": {
"properties": {
"newForceDownloadProof": {
"description": "The new forceDownloadProof-flag.",
"type": "boolean"
},
"oldForceDownloadProof": {
"description": "The old forceDownloadProof-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedForceDownloadProof",
"type": "object"
},
"PortalModifiedForceWatermark": {
"properties": {
"newForceWatermark": {
"description": "The new forceWatermark-flag.",
"type": "boolean"
},
"oldForceWatermark": {
"description": "The old forceWatermark-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedForceWatermark",
"type": "object"
},
"PortalModifiedHasUserRegistration": {
"properties": {
"newHasUserRegistration": {
"description": "The new hasUserRegistration-flag.",
"type": "boolean"
},
"oldHasUserRegistration": {
"description": "The old hasUserRegistration-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedHasUserRegistration",
"type": "object"
},
"PortalModifiedHasWhitelabel": {
"properties": {
"newHasWhitelabel": {
"description": "The new hasWhitelabel-flag.",
"type": "boolean"
},
"oldHasWhitelabel": {
"description": "The old hasWhitelabel-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedHasWhitelabel",
"type": "object"
},
"PortalModifiedHeroArrowColor": {
"properties": {
"newHeroArrowColor": {
"description": "The new heroArrowColor.",
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
},
"oldHeroArrowColor": {
"description": "The old heroArrowColor.",
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
}
},
"title": "PortalModifiedHeroArrowColor",
"type": "object"
},
"PortalModifiedHeroFontColor": {
"properties": {
"newHeroFontColor": {
"description": "The new heroFontColor.",
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
},
"oldHeroFontColor": {
"description": "The old heroFontColor.",
"enum": [
"black",
"white"
],
"example": "white",
"title": "PortalFontColor",
"type": "string"
}
},
"title": "PortalModifiedHeroFontColor",
"type": "object"
},
"PortalModifiedHeroLogoColor": {
"properties": {
"newHeroLogoColor": {
"description": "The new heroLogoColor.",
"enum": [
"dark",
"light"
],
"example": "light",
"title": "PortalLogoColor",
"type": "string"
},
"oldHeroLogoColor": {
"description": "The old heroLogoColor.",
"enum": [
"dark",
"light"
],
"example": "light",
"title": "PortalLogoColor",
"type": "string"
}
},
"title": "PortalModifiedHeroLogoColor",
"type": "object"
},
"PortalModifiedHostNames": {
"properties": {
"newHostNames": {
"items": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"type": "array"
},
"oldHostNames": {
"items": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"type": "array"
}
},
"title": "PortalModifiedHostNames",
"type": "object"
},
"PortalModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedIsActive",
"type": "object"
},
"PortalModifiedLandingPageOptions": {
"properties": {
"newLandingPageOptions": {
"description": "The new landingPageOption.",
"enum": [
"collections",
"collectionsAndFiles",
"files"
],
"example": "collectionsAndFiles",
"title": "PortalLandingPageOptions",
"type": "string"
},
"oldLandingPageOptions": {
"description": "The old landingPageOption.",
"enum": [
"collections",
"collectionsAndFiles",
"files"
],
"example": "collectionsAndFiles",
"title": "PortalLandingPageOptions",
"type": "string"
}
},
"title": "PortalModifiedLandingPageOptions",
"type": "object"
},
"PortalModifiedLanguagesAdded": {
"properties": {
"languagesAdded": {
"$ref": "#/components/schemas/ArraySchema_3739343737"
}
},
"title": "PortalModifiedLanguagesAdded",
"type": "object"
},
"PortalModifiedLanguagesRemoved": {
"properties": {
"languagesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3035643235"
}
},
"title": "PortalModifiedLanguagesRemoved",
"type": "object"
},
"PortalModifiedLicenseReleaseIDsAdded": {
"properties": {
"licenseReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3438326230"
}
},
"title": "PortalModifiedLicenseReleaseIDsAdded",
"type": "object"
},
"PortalModifiedLicenseReleaseIDsRemoved": {
"properties": {
"licenseReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema"
}
},
"title": "PortalModifiedLicenseReleaseIDsRemoved",
"type": "object"
},
"PortalModifiedMainHostName": {
"properties": {
"newMainHostName": {
"description": "The bew mainHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldMainHostName": {
"description": "The old mainHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "PortalModifiedMainHostName",
"type": "object"
},
"PortalModifiedMediaViewsAdded": {
"properties": {
"mediaViewsAdded": {
"$ref": "#/components/schemas/ArraySchema_3530643134"
}
},
"title": "PortalModifiedMediaViewsAdded",
"type": "object"
},
"PortalModifiedMediaViewsRemoved": {
"properties": {
"mediaViewsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3334343039"
}
},
"title": "PortalModifiedMediaViewsRemoved",
"type": "object"
},
"PortalModifiedModelReleaseIDsAdded": {
"properties": {
"modelReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6430343739"
}
},
"title": "PortalModifiedModelReleaseIDsAdded",
"type": "object"
},
"PortalModifiedModelReleaseIDsRemoved": {
"properties": {
"modelReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6638656432"
}
},
"title": "PortalModifiedModelReleaseIDsRemoved",
"type": "object"
},
"PortalModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PortalModifiedName",
"type": "object"
},
"PortalModifiedOriginalDownloadFormatTypesAdded": {
"properties": {
"originalDownloadFormatTypesAdded": {
"$ref": "#/components/schemas/ArraySchema_6339343636"
}
},
"title": "PortalModifiedOriginalDownloadFormatTypesAdded",
"type": "object"
},
"PortalModifiedOriginalDownloadFormatTypesRemoved": {
"properties": {
"originalDownloadFormatTypesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3561636530"
}
},
"title": "PortalModifiedOriginalDownloadFormatTypesRemoved",
"type": "object"
},
"PortalModifiedPageName": {
"properties": {
"newName": {
"description": "The new pageName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old pageName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"page": {
"$ref": "#/components/schemas/PortalPageInfo_3434333763"
}
},
"title": "PortalModifiedPageName",
"type": "object"
},
"PortalModifiedPageText": {
"properties": {
"newText": {
"description": "The new pageText.",
"type": "string"
},
"oldText": {
"description": "The old pageText.",
"type": "string"
},
"page": {
"$ref": "#/components/schemas/PortalPageInfo_3434333763"
}
},
"title": "PortalModifiedPageText",
"type": "object"
},
"PortalModifiedPagesAdded": {
"properties": {
"pagesAdded": {
"$ref": "#/components/schemas/ArraySchema_3733313866"
}
},
"title": "PortalModifiedPagesAdded",
"type": "object"
},
"PortalModifiedPagesRemoved": {
"properties": {
"pagesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3232386430"
}
},
"title": "PortalModifiedPagesRemoved",
"type": "object"
},
"PortalModifiedPlacementsAdded": {
"properties": {
"placementsAdded": {
"$ref": "#/components/schemas/ArraySchema_6162366235"
}
},
"title": "PortalModifiedPlacementsAdded",
"type": "object"
},
"PortalModifiedPlacementsRemoved": {
"properties": {
"placementsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3935383130"
}
},
"title": "PortalModifiedPlacementsRemoved",
"type": "object"
},
"PortalModifiedPreferredMode": {
"properties": {
"newPreferredMode": {
"description": "The new preferredMode.",
"enum": [
"DARK",
"LIGHT",
"SYSTEM"
],
"example": "SYSTEM",
"title": "PortalDesignType",
"type": "string"
},
"oldPreferredMode": {
"description": "The old preferredMode.",
"enum": [
"DARK",
"LIGHT",
"SYSTEM"
],
"example": "SYSTEM",
"title": "PortalDesignType",
"type": "string"
}
},
"title": "PortalModifiedPreferredMode",
"type": "object"
},
"PortalModifiedPreferredTitle": {
"properties": {
"newPreferredTitle": {
"$ref": "#/components/schemas/PortalTitleObject_6566386338"
},
"oldPreferredTitle": {
"$ref": "#/components/schemas/PortalTitleObject_3865613062"
}
},
"title": "PortalModifiedPreferredTitle",
"type": "object"
},
"PortalModifiedPropertyReleaseIDsAdded": {
"properties": {
"propertyReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3939316139"
}
},
"title": "PortalModifiedPropertyReleaseIDsAdded",
"type": "object"
},
"PortalModifiedPropertyReleaseIDsRemoved": {
"properties": {
"propertyReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3139333730"
}
},
"title": "PortalModifiedPropertyReleaseIDsRemoved",
"type": "object"
},
"PortalModifiedRestrictAccess": {
"properties": {
"newRestrictAccess": {
"description": "The new restrictAccess-flag.",
"type": "boolean"
},
"oldRestrictAccess": {
"description": "The old restrictAccess-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedRestrictAccess",
"type": "object"
},
"PortalModifiedSearchFieldsAdded": {
"properties": {
"searchFieldsAdded": {
"$ref": "#/components/schemas/ArraySchema_6163373163"
}
},
"title": "PortalModifiedSearchFieldsAdded",
"type": "object"
},
"PortalModifiedSearchFieldsRemoved": {
"properties": {
"searchFieldsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3639323535"
}
},
"title": "PortalModifiedSearchFieldsRemoved",
"type": "object"
},
"PortalModifiedShowAllLicenseReleases": {
"properties": {
"newShowAllLicenseReleases": {
"description": "The new showAllLicenseReleases-flag.",
"type": "boolean"
},
"oldShowAllLicenseReleases": {
"description": "The old showAllLicenseReleases-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowAllLicenseReleases",
"type": "object"
},
"PortalModifiedShowAllModelReleases": {
"properties": {
"newShowAllModelReleases": {
"description": "The new showAllModelReleases-flag.",
"type": "boolean"
},
"oldShowAllModelReleases": {
"description": "The old showAllModelReleases-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowAllModelReleases",
"type": "object"
},
"PortalModifiedShowAllPropertyReleases": {
"properties": {
"newShowAllPropertyReleases": {
"description": "The new showAllPropertyReleases-flag.",
"type": "boolean"
},
"oldShowAllPropertyReleases": {
"description": "The old showAllPropertyReleases-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowAllPropertyReleases",
"type": "object"
},
"PortalModifiedShowBorder": {
"properties": {
"newShowBorder": {
"description": "The new showBorder-flag.",
"type": "boolean"
},
"oldShowBorder": {
"description": "The old showBorder-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowBorder",
"type": "object"
},
"PortalModifiedShowCookieInformation": {
"properties": {
"newShowCookieInformation": {
"description": "The new showCookieInformation-flag.",
"type": "boolean"
},
"oldShowCookieInformation": {
"description": "The old showCookieInformation-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowCookieInformation",
"type": "object"
},
"PortalModifiedShowCreateLinkToFileTab": {
"properties": {
"newShowCreateLinkToFileTab": {
"description": "The new showCreateLinkToFileTab-flag.",
"type": "boolean"
},
"oldShowCreateLinkToFileTab": {
"description": "The old showCreateLinkToFileTab-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowCreateLinkToFileTab",
"type": "object"
},
"PortalModifiedShowFileType": {
"properties": {
"newShowFileType": {
"description": "The new showFileType-flag.",
"type": "boolean"
},
"oldShowFileType": {
"description": "The old showFileType-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowFileType",
"type": "object"
},
"PortalModifiedShowLicenseReleaseFile": {
"properties": {
"newShowLicenseReleaseFile": {
"description": "The new showLicenseReleaseFile-flag.",
"type": "boolean"
},
"oldShowLicenseReleaseFile": {
"description": "The old showLicenseReleaseFile-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowLicenseReleaseFile",
"type": "object"
},
"PortalModifiedShowModelReleaseFile": {
"properties": {
"newShowModelReleaseFile": {
"description": "The new showModelReleaseFile-flag.",
"type": "boolean"
},
"oldShowModelReleaseFile": {
"description": "The old showModelReleaseFile-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowModelReleaseFile",
"type": "object"
},
"PortalModifiedShowPropertyReleaseFile": {
"properties": {
"newShowPropertyReleaseFile": {
"description": "The new showPropertyReleaseFile-flag.",
"type": "boolean"
},
"oldShowPropertyReleaseFile": {
"description": "The old showPropertyReleaseFile-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowPropertyReleaseFile",
"type": "object"
},
"PortalModifiedShowStartScreen": {
"properties": {
"newShowStartScreen": {
"description": "The new showStartScreen-flag.",
"type": "boolean"
},
"oldShowStartScreen": {
"description": "The old showStartScreen-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedShowStartScreen",
"type": "object"
},
"PortalModifiedSortOptionsAdded": {
"properties": {
"sortOptionsAdded": {
"$ref": "#/components/schemas/ArraySchema_3466613063"
}
},
"title": "PortalModifiedSortOptionsAdded",
"type": "object"
},
"PortalModifiedSortOptionsRemoved": {
"properties": {
"sortOptionsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6336313931"
}
},
"title": "PortalModifiedSortOptionsRemoved",
"type": "object"
},
"PortalModifiedStandardMetadataIDsAdded": {
"properties": {
"standardMetadataIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3639636131"
}
},
"title": "PortalModifiedStandardMetadataIDsAdded",
"type": "object"
},
"PortalModifiedStandardMetadataIDsRemoved": {
"properties": {
"standardMetadataIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3563633061"
}
},
"title": "PortalModifiedStandardMetadataIDsRemoved",
"type": "object"
},
"PortalModifiedUseSSO": {
"properties": {
"newUseSSO": {
"description": "The new useSSO-flag.",
"type": "boolean"
},
"oldUseSSO": {
"description": "The old useSSO-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedUseSSO",
"type": "object"
},
"PortalModifiedUseSemanticSearch": {
"properties": {
"newUseSemanticSearch": {
"description": "The new useSemanticSearch-flag.",
"type": "boolean"
},
"oldUseSemanticSearch": {
"description": "The old useSemanticSearch-flag.",
"type": "boolean"
}
},
"title": "PortalModifiedUseSemanticSearch",
"type": "object"
},
"PortalModifiedUserCompany": {
"properties": {
"newCompany": {
"description": "The new userCompany.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldCompany": {
"description": "The old userCompany.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserCompany",
"type": "object"
},
"PortalModifiedUserDepartment": {
"properties": {
"newDepartment": {
"description": "The new userDepartment.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldDepartment": {
"description": "The old userDepartment.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserDepartment",
"type": "object"
},
"PortalModifiedUserEmail": {
"properties": {
"newEmail": {
"description": "The new userEmail.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"oldEmail": {
"description": "The old userEmail.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserEmail",
"type": "object"
},
"PortalModifiedUserFirstName": {
"properties": {
"newFirstName": {
"description": "The new userFirstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldFirstName": {
"description": "The old userFirstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserFirstName",
"type": "object"
},
"PortalModifiedUserIsActive": {
"properties": {
"newIsActive": {
"description": "The new userIsActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old userIsActive-flag.",
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserIsActive",
"type": "object"
},
"PortalModifiedUserIsConfirmed": {
"properties": {
"newIsConfirmed": {
"description": "The new userIsConfirmed-flag.",
"type": "boolean"
},
"oldIsConfirmed": {
"description": "The old userIsConfirmed-flag.",
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserIsConfirmed",
"type": "object"
},
"PortalModifiedUserLanguage": {
"properties": {
"newLanguage": {
"description": "The new userLanguage.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"oldLanguage": {
"description": "The old userLanguage.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserLanguage",
"type": "object"
},
"PortalModifiedUserLastName": {
"properties": {
"newLastName": {
"description": "The new userLastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldLastName": {
"description": "The old userLastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserLastName",
"type": "object"
},
"PortalModifiedUserPassword": {
"properties": {
"user": {
"$ref": "#/components/schemas/UserInfo"
}
},
"title": "PortalModifiedUserPassword",
"type": "object"
},
"PortalModifiedUsersAdded": {
"properties": {
"usersAdded": {
"$ref": "#/components/schemas/ArraySchema_6663346135"
}
},
"title": "PortalModifiedUsersAdded",
"type": "object"
},
"PortalModifiedUsersRemoved": {
"properties": {
"usersRemoved": {
"$ref": "#/components/schemas/ArraySchema_3435316466"
}
},
"title": "PortalModifiedUsersRemoved",
"type": "object"
},
"PortalPackageForPortal": {
"properties": {
"inAppTag": {
"type": "string"
},
"name": {
"type": "string"
},
"packageIdentifier": {
"type": "string"
}
},
"title": "PortalPackageForPortal",
"type": "object"
},
"PortalPage": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"placements": {
"items": {
"description": "A placement of a portal page",
"enum": [
"cookie",
"download",
"footer",
"login",
"termsAndServices"
],
"example": "footer",
"title": "PortalPagePlacement",
"type": "string"
},
"type": "array"
},
"text": {
"type": "string"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
}
},
"title": "PortalPage",
"type": "object"
},
"PortalPageInfo": {
"description": "All important infos about a portal page.",
"example": {
"id": 1234,
"name": "home"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PortalPageInfo",
"type": "object"
},
"PortalPageInfo_3434333763": {
"description": "The page.",
"example": {
"id": 1234,
"name": "home"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PortalPageInfo",
"type": "object"
},
"PortalPageTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "PortalPageTranslationModifiedLanguage",
"type": "object"
},
"PortalPageTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PortalPageTranslationModifiedName",
"type": "object"
},
"PortalPageTranslationModifiedText": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newText": {
"description": "The new text.",
"type": "string"
},
"oldText": {
"description": "The old text.",
"type": "string"
}
},
"title": "PortalPageTranslationModifiedText",
"type": "object"
},
"PortalTitleObject": {
"example": {
"defaultMetadataField": "all",
"metadataFieldID": 1
},
"properties": {
"defaultMetadataField": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalTitleObject",
"type": "object"
},
"PortalTitleObject_3865613062": {
"description": "The old preferredTitle.",
"example": {
"defaultMetadataField": "all",
"metadataFieldID": 1
},
"properties": {
"defaultMetadataField": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalTitleObject",
"type": "object"
},
"PortalTitleObject_6566386338": {
"description": "The new preferredTitle.",
"example": {
"defaultMetadataField": "all",
"metadataFieldID": 1
},
"properties": {
"defaultMetadataField": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"metadataFieldID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "PortalTitleObject",
"type": "object"
},
"PortalTranslationModifiedCookieTextShort": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newCookieTextShort": {
"description": "The new cookieTextShort.",
"type": "string"
},
"oldCookieTextShort": {
"description": "The old cookieTextShort.",
"type": "string"
}
},
"title": "PortalTranslationModifiedCookieTextShort",
"type": "object"
},
"PortalTranslationModifiedFooterText": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newFooterText": {
"description": "The new footerText.",
"type": "string"
},
"oldFooterText": {
"description": "The old footerText.",
"type": "string"
}
},
"title": "PortalTranslationModifiedFooterText",
"type": "object"
},
"PortalTranslationModifiedHeroSlogan": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newHeroSlogan": {
"description": "The new heroSlogan.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldHeroSlogan": {
"description": "The old heroSlogan.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PortalTranslationModifiedHeroSlogan",
"type": "object"
},
"PortalTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "PortalTranslationModifiedLanguage",
"type": "object"
},
"PortalTranslationModifiedStartScreenText": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newStartScreenText": {
"description": "The new startscreentext.",
"type": "string"
},
"oldStartScreenText": {
"description": "The old startscreentext.",
"type": "string"
}
},
"title": "PortalTranslationModifiedStartScreenText",
"type": "object"
},
"PortalUser": {
"properties": {
"company": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"department": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isDoubleOptInVerified": {
"type": "boolean"
},
"language": {
"description": "language",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"password": {
"description": "An encrypted password.",
"example": "censored",
"title": "EncryptedPassword",
"type": "string"
}
},
"title": "PortalUser",
"type": "object"
},
"PreviewFileOption": {
"description": "\u003cp\u003eParameter to get URLs to scaled versions of the preview file in the response field modifiedPreviewFileURLs. Use this parameter to display thumbnails in your application.\u003c/p\u003e ",
"example": {
"addWatermark": true,
"directDownload": true,
"minSize": 100,
"quality": 95,
"rotation": 90
},
"properties": {
"addWatermark": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"directDownload": {
"description": "A bool with valid zero value \"false\".\u003cbr\u003e\u003cp\u003e\u003ccode\u003edirectDownload: false\u003c/code\u003e: Adds the following Content-Disposition Header to the Response of the Preview File URL:\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eContent-Disposition: inline; filename=MyFileName.jpg; filename*= UTF-8''MyFileName.jpg \u003ccode\u003edirectDownload: true\u003c/code\u003e: Adds the following Content-Disposition Header to the Response of the Preview File URL:\u003c/p\u003e\n\u003cp\u003eContent-Disposition: attachment; filename=MyFileName.jpg; filename*= UTF-8''MyFileName.jpg\u003c/p\u003e \u003c/blockquote\u003e\n\u003cp\u003eCaution: directDownload is ignored when the same option also asks for a transformation, which is any of width, height, minSize, maxSize, quality, rotation and addWatermark. Such a URL answers with the transformed image inline, as though directDownload had not been sent. A transformed image and a download cannot both be served: a download has to arrive as an attachment under a file name of its own, and the image service that performs the transformation answers with an image and nothing else. To download a file, send an option that asks for no transformation.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"height": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"maxSize": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"minSize": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
},
"quality": {
"description": "The quality in percent of the converted file.",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
},
"rotation": {
"description": "The rotation in degrees of the converted file (0, 90, 180 or 270).",
"example": 90,
"title": "Rotation",
"type": "integer"
},
"width": {
"description": "The length measured in pixel.",
"example": 687,
"minimum": 1,
"title": "Pixel",
"type": "integer"
}
},
"title": "PreviewFileOption",
"type": "object"
},
"Property": {
"description": "The property.",
"properties": {
"address": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"owner": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
},
"type": "array"
}
},
"title": "Property",
"type": "object"
},
"PropertyBasic": {
"properties": {
"address": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"owner": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyBasic",
"type": "object"
},
"PropertyFileModifiedColor": {
"properties": {
"newColor": {
"description": "The new color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldColor": {
"description": "The old color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "PropertyFileModifiedColor",
"type": "object"
},
"PropertyFileModifiedCreateDate": {
"properties": {
"newCreateDate": {
"description": "The new createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldCreateDate": {
"description": "The old createDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "PropertyFileModifiedCreateDate",
"type": "object"
},
"PropertyFileModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyFileModifiedName",
"type": "object"
},
"PropertyFileModifiedShowFile": {
"properties": {
"newShowFile": {
"description": "The new showFile-flag.",
"type": "boolean"
},
"oldShowFile": {
"description": "The old showFile-flag.",
"type": "boolean"
}
},
"title": "PropertyFileModifiedShowFile",
"type": "object"
},
"PropertyFileModifiedShowWarningMessage": {
"properties": {
"newShowWarningMessage": {
"description": "The new showWarningMessage-flag.",
"type": "boolean"
},
"oldShowWarningMessage": {
"description": "The old showWarningMessage-flag.",
"type": "boolean"
}
},
"title": "PropertyFileModifiedShowWarningMessage",
"type": "object"
},
"PropertyFileModifiedWarningMessage": {
"properties": {
"newWarningMessage": {
"description": "The new warningMessage.",
"type": "string"
},
"oldWarningMessage": {
"description": "The old warningMessage.",
"type": "string"
}
},
"title": "PropertyFileModifiedWarningMessage",
"type": "object"
},
"PropertyModifiedAddress": {
"properties": {
"newAddress": {
"description": "The new address.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldAddress": {
"description": "The old address.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyModifiedAddress",
"type": "object"
},
"PropertyModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyModifiedName",
"type": "object"
},
"PropertyModifiedOwner": {
"properties": {
"newOwner": {
"description": "The new owner.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOwner": {
"description": "The old owner.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyModifiedOwner",
"type": "object"
},
"PropertyRelease": {
"description": "The propertyRelease.",
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"type": "string"
},
"property": {
"$ref": "#/components/schemas/PropertyBasic"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "PropertyRelease",
"type": "object"
},
"PropertyReleaseBasic": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"type": "string"
},
"property": {
"$ref": "#/components/schemas/PropertyBasic"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "PropertyReleaseBasic",
"type": "object"
},
"PropertyReleaseForFile": {
"properties": {
"expires": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"propertyRelease": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
}
},
"title": "PropertyReleaseForFile",
"type": "object"
},
"PropertyReleaseTranslationModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
"title": "PropertyReleaseTranslationModifiedLanguage",
"type": "object"
},
"PropertyReleaseTranslationModifiedName": {
"properties": {
"language": {
"description": "The language of the translation.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
},
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "PropertyReleaseTranslationModifiedName",
"type": "object"
},
"PropertyRelease_6136373361": {
"properties": {
"color": {
"description": "HexColor is a type that represents a hex color.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"fileName": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileURL": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"type": "string"
},
"property": {
"$ref": "#/components/schemas/PropertyBasic"
},
"releaseCreateDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"type": "boolean"
},
"showWarningMessage": {
"type": "boolean"
},
"translationState": {
"items": {
"$ref": "#/components/schemas/CustomMetadataTranslationStateObject"
},
"type": "array"
},
"warningMessage": {
"type": "string"
}
},
"title": "PropertyRelease",
"type": "object"
},
"Property_3530383236": {
"properties": {
"address": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"owner": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
},
"type": "array"
}
},
"title": "Property",
"type": "object"
},
"RecognizedText": {
"description": "A text item detected in an image or video.",
"example": {
"boundingBox": {
"height": 100.46,
"left": 50.5,
"top": 50.5,
"width": 100.5
},
"detectedText": "",
"id": 123
},
"properties": {
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"detectedText": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "RecognizedText",
"type": "object"
},
"ReportEvent": {
"example": {
"days": 7,
"reportEventType": "loginAttempts"
},
"properties": {
"diskSpace": {
"$ref": "#/components/schemas/ReportEventDiskSpace"
},
"downloadedFiles": {
"$ref": "#/components/schemas/ReportEventDownloadedFiles"
},
"externalShares": {
"$ref": "#/components/schemas/ReportEventExternalShares"
},
"licenseExpiringFiles": {
"$ref": "#/components/schemas/ReportEventLicenseExpiringFiles"
},
"loginAttempts": {
"$ref": "#/components/schemas/ReportEventLoginAttempts"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
},
"statusTrackedFiles": {
"$ref": "#/components/schemas/ReportEventStatusTrackedFiles"
},
"uploadedFiles": {
"$ref": "#/components/schemas/ReportEventUploadedFiles"
}
},
"title": "ReportEvent",
"type": "object"
},
"ReportEventDiskSpace": {
"example": {
"reportEventType": "diskSpace"
},
"properties": {
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventDiskSpace",
"type": "object"
},
"ReportEventDownloadedFiles": {
"example": {
"days": 7,
"reportEventType": "downloadedFiles"
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventDownloadedFiles",
"type": "object"
},
"ReportEventExternalShares": {
"example": {
"days": 7,
"reportEventType": "externalShares"
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventExternalShares",
"type": "object"
},
"ReportEventLicenseExpiringFiles": {
"example": {
"days": 7,
"reportEventType": "licenseExpiringFiles"
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventLicenseExpiringFiles",
"type": "object"
},
"ReportEventLoginAttempts": {
"example": {
"days": 7,
"reportEventType": "loginAttempts"
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventLoginAttempts",
"type": "object"
},
"ReportEventStatusTrackedFiles": {
"example": {
"additionalKeywords": [
"keyword1",
"keyword2"
],
"days": 7,
"fileStateIDs": [
1,
2,
3
],
"reportEventType": "statusTrackedFiles"
},
"properties": {
"additionalKeywords": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"fileStateIDs": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventStatusTrackedFiles",
"type": "object"
},
"ReportEventUploadedFiles": {
"example": {
"days": 7,
"reportEventType": "uploadedFiles"
},
"properties": {
"days": {
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
},
"reportEventType": {
"description": "The type of the report event.",
"enum": [
"diskSpace",
"downloadedFiles",
"externalShares",
"licenseExpiringFiles",
"loginAttempts",
"statusTrackedFiles",
"uploadedFiles"
],
"example": "loginAttempts",
"title": "ReportEventType",
"type": "string"
}
},
"title": "ReportEventUploadedFiles",
"type": "object"
},
"ReportModifiedAdditionalText": {
"properties": {
"newAdditionalText": {
"description": "The new additionalText.",
"type": "string"
},
"oldAdditionalText": {
"description": "The old additionalText.",
"type": "string"
}
},
"title": "ReportModifiedAdditionalText",
"type": "object"
},
"ReportModifiedDayInMonth": {
"properties": {
"newDayInMonth": {
"description": "The new dayInMonth.",
"example": 1,
"maximum": 31,
"minimum": 1,
"title": "Day",
"type": "integer"
},
"oldDayInMonth": {
"description": "The old dayInMonth.",
"example": 1,
"maximum": 31,
"minimum": 1,
"title": "Day",
"type": "integer"
}
},
"title": "ReportModifiedDayInMonth",
"type": "object"
},
"ReportModifiedDayInWeek": {
"properties": {
"newDayInWeek": {
"description": "The new dayInWeek.",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
],
"example": "Sunday",
"title": "Weekday",
"type": "string"
},
"oldDayInWeek": {
"description": "The old dayInWeek.",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
],
"example": "Sunday",
"title": "Weekday",
"type": "string"
}
},
"title": "ReportModifiedDayInWeek",
"type": "object"
},
"ReportModifiedDayTime": {
"properties": {
"newDayTime": {
"description": "The new dayTime.",
"example": "12:00",
"title": "Daytime",
"type": "string"
},
"oldDayTime": {
"description": "The old dayTime.",
"example": "12:00",
"title": "Daytime",
"type": "string"
}
},
"title": "ReportModifiedDayTime",
"type": "object"
},
"ReportModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "ReportModifiedIsActive",
"type": "object"
},
"ReportModifiedName": {
"properties": {
"newName": {
"description": "The bew name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "ReportModifiedName",
"type": "object"
},
"ReportModifiedReceiverEmailsAdded": {
"properties": {
"emailsAdded": {
"$ref": "#/components/schemas/ArraySchema_3765353461"
}
},
"title": "ReportModifiedReceiverEmailsAdded",
"type": "object"
},
"ReportModifiedReceiverEmailsRemoved": {
"properties": {
"emailsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3934656561"
}
},
"title": "ReportModifiedReceiverEmailsRemoved",
"type": "object"
},
"ReportModifiedReportEventsAdded": {
"properties": {
"reportEventsAdded": {
"$ref": "#/components/schemas/ArraySchema_6136313961"
}
},
"title": "ReportModifiedReportEventsAdded",
"type": "object"
},
"ReportModifiedReportEventsRemoved": {
"properties": {
"reportEventsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3832323563"
}
},
"title": "ReportModifiedReportEventsRemoved",
"type": "object"
},
"ReportModifiedReportEventsReplaced": {
"properties": {
"reportEventsReplaced": {
"$ref": "#/components/schemas/ArraySchema_3965393533"
}
},
"title": "ReportModifiedReportEventsReplaced",
"type": "object"
},
"ReportModifiedReportInterval": {
"properties": {
"newReportInterval": {
"description": "The new reportInterval.",
"enum": [
"daily",
"monthly",
"weekly"
],
"example": "daily",
"title": "ReportInterval",
"type": "string"
},
"oldReportInterval": {
"description": "The old reportInterval.",
"enum": [
"daily",
"monthly",
"weekly"
],
"example": "daily",
"title": "ReportInterval",
"type": "string"
}
},
"title": "ReportModifiedReportInterval",
"type": "object"
},
"ReportModifiedReportWhenNoData": {
"properties": {
"newReportWhenNoData": {
"description": "The new reportWhenNoData-flag.",
"type": "boolean"
},
"oldReportWhenNoData": {
"description": "The old reportWhenNoData-flag.",
"type": "boolean"
}
},
"title": "ReportModifiedReportWhenNoData",
"type": "object"
},
"ReportModifiedSendCSV": {
"properties": {
"newSendCSV": {
"description": "The new sendCSV-flag.",
"type": "boolean"
},
"oldSendCSV": {
"description": "The old sendCSV-flag.",
"type": "boolean"
}
},
"title": "ReportModifiedSendCSV",
"type": "object"
},
"ReportModifiedSendPDF": {
"properties": {
"newSendPDF": {
"description": "The new sendPDF-flag.",
"type": "boolean"
},
"oldSendPDF": {
"description": "The old sendPDF-flag.",
"type": "boolean"
}
},
"title": "ReportModifiedSendPDF",
"type": "object"
},
"SettingsModifiedCustomJavaScript": {
"properties": {
"newCustomJavaScript": {
"description": "The new customJavaScript.",
"type": "string"
},
"oldCustomJavaScript": {
"description": "The old customJavaScript.",
"type": "string"
}
},
"title": "SettingsModifiedCustomJavaScript",
"type": "object"
},
"SettingsModifiedDateFormat": {
"properties": {
"newDateFormat": {
"description": "The new dateFormat.",
"enum": [
"af",
"ar",
"ar-dz",
"ar-kw",
"ar-ly",
"ar-ma",
"ar-sa",
"ar-tn",
"az",
"be",
"bg",
"bm",
"bn",
"bn-bd",
"bo",
"br",
"bs",
"ca",
"cs",
"cv",
"cy",
"da",
"de",
"de-at",
"de-ch",
"dv",
"el",
"en-au",
"en-ca",
"en-gb",
"en-ie",
"en-il",
"en-in",
"en-nz",
"en-sg",
"eo",
"es",
"es-do",
"es-mx",
"es-us",
"et",
"eu",
"fa",
"fi",
"fil",
"fo",
"fr",
"fr-ca",
"fr-ch",
"fy",
"ga",
"gd",
"gl",
"gom-deva",
"gom-latn",
"gu",
"he",
"hi",
"hr",
"hu",
"hy-am",
"id",
"is",
"it",
"it-ch",
"ja",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"ku",
"ky",
"lb",
"lo",
"lt",
"lv",
"me",
"mi",
"mk",
"ml",
"mn",
"mr",
"ms",
"ms-my",
"mt",
"my",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"oc-lnc",
"pa-in",
"pl",
"pt",
"pt-br",
"ro",
"ru",
"sd",
"se",
"si",
"sk",
"sl",
"sq",
"sr",
"sr-cyrl",
"ss",
"sv",
"sw",
"ta",
"te",
"tet",
"tg",
"th",
"tk",
"tl-ph",
"tlh",
"tr",
"tzl",
"tzm",
"tzm-latn",
"ug-cn",
"uk",
"ur",
"uz",
"uz-latn",
"vi",
"x-pseudo",
"yo",
"zh-cn",
"zh-hk",
"zh-mo",
"zh-tw"
],
"example": "de",
"title": "DateFormat",
"type": "string"
},
"oldDateFormat": {
"description": "The old dateFormat.",
"enum": [
"af",
"ar",
"ar-dz",
"ar-kw",
"ar-ly",
"ar-ma",
"ar-sa",
"ar-tn",
"az",
"be",
"bg",
"bm",
"bn",
"bn-bd",
"bo",
"br",
"bs",
"ca",
"cs",
"cv",
"cy",
"da",
"de",
"de-at",
"de-ch",
"dv",
"el",
"en-au",
"en-ca",
"en-gb",
"en-ie",
"en-il",
"en-in",
"en-nz",
"en-sg",
"eo",
"es",
"es-do",
"es-mx",
"es-us",
"et",
"eu",
"fa",
"fi",
"fil",
"fo",
"fr",
"fr-ca",
"fr-ch",
"fy",
"ga",
"gd",
"gl",
"gom-deva",
"gom-latn",
"gu",
"he",
"hi",
"hr",
"hu",
"hy-am",
"id",
"is",
"it",
"it-ch",
"ja",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"ku",
"ky",
"lb",
"lo",
"lt",
"lv",
"me",
"mi",
"mk",
"ml",
"mn",
"mr",
"ms",
"ms-my",
"mt",
"my",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"oc-lnc",
"pa-in",
"pl",
"pt",
"pt-br",
"ro",
"ru",
"sd",
"se",
"si",
"sk",
"sl",
"sq",
"sr",
"sr-cyrl",
"ss",
"sv",
"sw",
"ta",
"te",
"tet",
"tg",
"th",
"tk",
"tl-ph",
"tlh",
"tr",
"tzl",
"tzm",
"tzm-latn",
"ug-cn",
"uk",
"ur",
"uz",
"uz-latn",
"vi",
"x-pseudo",
"yo",
"zh-cn",
"zh-hk",
"zh-mo",
"zh-tw"
],
"example": "de",
"title": "DateFormat",
"type": "string"
}
},
"title": "SettingsModifiedDateFormat",
"type": "object"
},
"SettingsModifiedExternalCollectionSyncHostName": {
"properties": {
"newExternalCollectionSyncHostName": {
"description": "The new externalCollectionSyncHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldExternalCollectionSyncHostName": {
"description": "The old externalCollectionSyncHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "SettingsModifiedExternalCollectionSyncHostName",
"type": "object"
},
"SettingsModifiedExternalCollectionSyncUserName": {
"properties": {
"newExternalCollectionSyncUserName": {
"description": "The new externalCollectionSyncUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldExternalCollectionSyncUserName": {
"description": "The old externalCollectionSyncUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "SettingsModifiedExternalCollectionSyncUserName",
"type": "object"
},
"SettingsModifiedExternalCustomCss": {
"properties": {
"newExternalCustomCss": {
"description": "The new externalCustomCss.",
"type": "string"
},
"oldExternalCustomCss": {
"description": "The old externalCustomCss.",
"type": "string"
}
},
"title": "SettingsModifiedExternalCustomCss",
"type": "object"
},
"SettingsModifiedExternalShareHostName": {
"properties": {
"newExternalShareHostName": {
"description": "The new externalShareHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldExternalShareHostName": {
"description": "The old externalShareHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "SettingsModifiedExternalShareHostName",
"type": "object"
},
"SettingsModifiedExternalShareUserName": {
"properties": {
"newExternalShareUserName": {
"description": "The new externalShareUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldExternalShareUserName": {
"description": "The old externalShareUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "SettingsModifiedExternalShareUserName",
"type": "object"
},
"SettingsModifiedFaviconFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedFaviconFile",
"type": "object"
},
"SettingsModifiedFaviconText": {
"properties": {
"newFaviconText": {
"description": "The new faviconText.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldFaviconText": {
"description": "The old faviconText.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SettingsModifiedFaviconText",
"type": "object"
},
"SettingsModifiedFont": {
"properties": {
"newFont": {
"description": "The new font.",
"enum": [
"Heebo"
],
"example": "Heebo",
"title": "Font",
"type": "string"
},
"oldFont": {
"description": "The old font.",
"enum": [
"Heebo"
],
"example": "Heebo",
"title": "Font",
"type": "string"
}
},
"title": "SettingsModifiedFont",
"type": "object"
},
"SettingsModifiedLogoBigDark": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoBigDark",
"type": "object"
},
"SettingsModifiedLogoBigLight": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoBigLight",
"type": "object"
},
"SettingsModifiedLogoBootFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoBootFile",
"type": "object"
},
"SettingsModifiedLogoDarkFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoDarkFile",
"type": "object"
},
"SettingsModifiedLogoFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoFile",
"type": "object"
},
"SettingsModifiedLogoIconDark": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoIconDark",
"type": "object"
},
"SettingsModifiedLogoIconLight": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedLogoIconLight",
"type": "object"
},
"SettingsModifiedLogoLink": {
"properties": {
"newLogoLink": {
"description": "The new logoLink.",
"type": "string"
},
"oldLogoLink": {
"description": "The old logoLink.",
"type": "string"
}
},
"title": "SettingsModifiedLogoLink",
"type": "object"
},
"SettingsModifiedPrimaryColorDark": {
"properties": {
"newPrimaryColorDark": {
"description": "The new primaryColorDark.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldPrimaryColorDark": {
"description": "The old primaryColorDark.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SettingsModifiedPrimaryColorDark",
"type": "object"
},
"SettingsModifiedPrimaryColorLight": {
"properties": {
"newPrimaryColorLight": {
"description": "The new primaryColorLight.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldPrimaryColorLight": {
"description": "The old primaryColorLight.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SettingsModifiedPrimaryColorLight",
"type": "object"
},
"SettingsModifiedProxyHostName": {
"properties": {
"newProxyHostName": {
"description": "The new proxyHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldProxyHostName": {
"description": "The old proxyHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "SettingsModifiedProxyHostName",
"type": "object"
},
"SettingsModifiedProxyPort": {
"properties": {
"newProxyPort": {
"description": "The new proxyPort.",
"example": 8080,
"title": "Port",
"type": "integer"
},
"oldProxyPort": {
"description": "The old proxyPort.",
"example": 8080,
"title": "Port",
"type": "integer"
}
},
"title": "SettingsModifiedProxyPort",
"type": "object"
},
"SettingsModifiedSMTPHasSSL": {
"properties": {
"newSMTPHasSSL": {
"description": "The new SMTPHasSSL.",
"type": "boolean"
},
"oldSMTPHasSSL": {
"description": "The old SMTPHasSSL.",
"type": "boolean"
}
},
"title": "SettingsModifiedSMTPHasSSL",
"type": "object"
},
"SettingsModifiedSMTPHostName": {
"properties": {
"newSMTPHostName": {
"description": "The new SMTPHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldSMTPHostName": {
"description": "The old SMTPHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "SettingsModifiedSMTPHostName",
"type": "object"
},
"SettingsModifiedSMTPPort": {
"properties": {
"newSMTPPort": {
"description": "The new SMTPPort.",
"example": 8080,
"title": "Port",
"type": "integer"
},
"oldSMTPPort": {
"description": "The old SMTPPort.",
"example": 8080,
"title": "Port",
"type": "integer"
}
},
"title": "SettingsModifiedSMTPPort",
"type": "object"
},
"SettingsModifiedSMTPTransmitterEmail": {
"properties": {
"newSMTPTransmitterEmail": {
"description": "The new SMTPTransmitterEmail.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"oldSMTPTransmitterEmail": {
"description": "The old SMTPTransmitterEmail.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
},
"title": "SettingsModifiedSMTPTransmitterEmail",
"type": "object"
},
"SettingsModifiedSMTPTransmitterName": {
"properties": {
"newSMTPTransmitterName": {
"description": "The new SMTPTransmitterName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSMTPTransmitterName": {
"description": "The old SMTPTransmitterName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SettingsModifiedSMTPTransmitterName",
"type": "object"
},
"SettingsModifiedSMTPUseDefault": {
"properties": {
"newSMTPUseDefault": {
"description": "The new SMTPUseDefault.",
"type": "boolean"
},
"oldSMTPUseDefault": {
"description": "The old SMTPUseDefault.",
"type": "boolean"
}
},
"title": "SettingsModifiedSMTPUseDefault",
"type": "object"
},
"SettingsModifiedSMTPUserName": {
"properties": {
"newSMTPUserName": {
"description": "The new SMTPUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldSMTPUserName": {
"description": "The old SMTPUserName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "SettingsModifiedSMTPUserName",
"type": "object"
},
"SettingsModifiedSecondaryColorDark": {
"properties": {
"newSecondaryColorDark": {
"description": "The new secondaryColorDark.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldSecondaryColorDark": {
"description": "The old secondaryColorDark.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SettingsModifiedSecondaryColorDark",
"type": "object"
},
"SettingsModifiedSecondaryColorLight": {
"properties": {
"newSecondaryColorLight": {
"description": "The new secondaryColorLight.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldSecondaryColorLight": {
"description": "The old secondaryColorLight.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SettingsModifiedSecondaryColorLight",
"type": "object"
},
"SettingsModifiedSloganStartscreen": {
"properties": {
"newSloganStartscreen": {
"description": "The new sloganStartscreen.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSloganStartscreen": {
"description": "The old sloganStartscreen.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SettingsModifiedSloganStartscreen",
"type": "object"
},
"SettingsModifiedStartscreenFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedStartscreenFile",
"type": "object"
},
"SettingsModifiedUploadLinkBackgroundFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedUploadLinkBackgroundFile",
"type": "object"
},
"SettingsModifiedWatermarkFile": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkFile",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsBottomLeft": {
"properties": {
"newWatermarkPositionIsBottomLeft": {
"description": "The new watermarkPositionIsBottomLeft-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsBottomLeft": {
"description": "The old watermarkPositionIsBottomLeft-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsBottomLeft",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsBottomMiddle": {
"properties": {
"newWatermarkPositionIsBottomMiddle": {
"description": "The new watermarkPositionIsBottomMiddle-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsBottomMiddle": {
"description": "The old watermarkPositionIsBottomMiddle-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsBottomMiddle",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsBottomRight": {
"properties": {
"newWatermarkPositionIsBottomRight": {
"description": "The new watermarkPositionIsBottomRight-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsBottomRight": {
"description": "The old watermarkPositionIsBottomRight-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsBottomRight",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsCenter": {
"properties": {
"newWatermarkPositionIsCenter": {
"description": "The new watermarkPositionIsCenter-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsCenter": {
"description": "The old watermarkPositionIsCenter-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsCenter",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsMiddleLeft": {
"properties": {
"newWatermarkPositionIsMiddleLeft": {
"description": "The new watermarkPositionIsMiddleLeft-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsMiddleLeft": {
"description": "The old watermarkPositionIsMiddleLeft-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsMiddleLeft",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsMiddleRight": {
"properties": {
"newWatermarkPositionIsMiddleRight": {
"description": "The new watermarkPositionIsMiddleRight-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsMiddleRight": {
"description": "The old watermarkPositionIsMiddleRight-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsMiddleRight",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsUpperLeft": {
"properties": {
"newWatermarkPositionIsUpperLeft": {
"description": "The new watermarkPositionIsUpperLeft-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsUpperLeft": {
"description": "The old watermarkPositionIsUpperLeft-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsUpperLeft",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsUpperMiddle": {
"properties": {
"newWatermarkPositionIsUpperMiddle": {
"description": "The new watermarkPositionIsUpperMiddle-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsUpperMiddle": {
"description": "The old watermarkPositionIsUpperMiddle-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsUpperMiddle",
"type": "object"
},
"SettingsModifiedWatermarkPositionIsUpperRight": {
"properties": {
"newWatermarkPositionIsUpperRight": {
"description": "The new watermarkPositionIsUpperRight-flag.",
"type": "boolean"
},
"oldWatermarkPositionIsUpperRight": {
"description": "The old watermarkPositionIsUpperRight-flag.",
"type": "boolean"
}
},
"title": "SettingsModifiedWatermarkPositionIsUpperRight",
"type": "object"
},
"SettingsModifiedWatermarkPositioningType": {
"properties": {
"newWatermarkPositioningType": {
"description": "The new watermarkPositioningType-flag.",
"enum": [
"aut",
"man"
],
"example": "man",
"title": "WatermarkPositioningType",
"type": "string"
},
"oldWatermarkPositioningType": {
"description": "The old watermarkPositioningType-flag.",
"enum": [
"aut",
"man"
],
"example": "man",
"title": "WatermarkPositioningType",
"type": "string"
}
},
"title": "SettingsModifiedWatermarkPositioningType",
"type": "object"
},
"SettingsModifiedWatermarkText": {
"properties": {
"newWatermarkText": {
"description": "The new watermarkText.",
"type": "string"
},
"oldWatermarkText": {
"description": "The old watermarkText.",
"type": "string"
}
},
"title": "SettingsModifiedWatermarkText",
"type": "object"
},
"SettingsModifiedWatermarkTransparency": {
"properties": {
"newWatermarkTransparency": {
"description": "The new watermarkTransparency.",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
},
"oldWatermarkTransparency": {
"description": "The old watermarkTransparency.",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
}
},
"title": "SettingsModifiedWatermarkTransparency",
"type": "object"
},
"SettingsModifiedWatermarkWidthPercent": {
"properties": {
"newWatermarkWidthPercent": {
"description": "The new watermarkWidthPercent.",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
},
"oldWatermarkWidthPercent": {
"description": "The old watermarkWidthPercent.",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
}
},
"title": "SettingsModifiedWatermarkWidthPercent",
"type": "object"
},
"SpaceModifiedAutomaticallyActivatedDomainsAdded": {
"properties": {
"automaticallyActivatedDomainsAdded": {
"$ref": "#/components/schemas/ArraySchema_6335373834"
}
},
"title": "SpaceModifiedAutomaticallyActivatedDomainsAdded",
"type": "object"
},
"SpaceModifiedAutomaticallyActivatedDomainsRemoved": {
"properties": {
"automaticallyActivatedDomainsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3231333833"
}
},
"title": "SpaceModifiedAutomaticallyActivatedDomainsRemoved",
"type": "object"
},
"SpaceModifiedCopyrightText": {
"properties": {
"newCopyrightText": {
"type": "string"
},
"oldCopyrightText": {
"type": "string"
}
},
"title": "SpaceModifiedCopyrightText",
"type": "object"
},
"SpaceModifiedCustomBodyFontFileID": {
"properties": {
"newCustomFontFileID": {
"description": "The new customBodyFont  fileID in the mediaspace.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldCustomFontFileID": {
"description": "The new customBodyFont fileID in the mediaspace",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "SpaceModifiedCustomBodyFontFileID",
"type": "object"
},
"SpaceModifiedCustomHeadingsFontFileID": {
"properties": {
"newCustomFontFileID": {
"description": "The new customHeadingsFont fileID in the mediaspace.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldCustomFontFileID": {
"description": "The new customHeadingsFont fileID in the mediaspace",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "SpaceModifiedCustomHeadingsFontFileID",
"type": "object"
},
"SpaceModifiedCustomMetadataIDs": {
"properties": {
"customMetadataIDsAdded": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"customMetadataIDsRemoved": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "SpaceModifiedCustomMetadataIDs",
"type": "object"
},
"SpaceModifiedCustomization": {
"properties": {
"newCustomization": {
"type": "string"
},
"oldCustomization": {
"type": "string"
}
},
"title": "SpaceModifiedCustomization",
"type": "object"
},
"SpaceModifiedDefaultMetadataFields": {
"properties": {
"defaultMetadataFieldsAdded": {
"items": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"type": "array"
},
"defaultMetadataFieldsRemoved": {
"items": {
"description": "A default metadata field.",
"enum": [
"all",
"colorspace",
"createDate",
"creator",
"description",
"directory",
"dominantColor",
"fileExtension",
"fileName",
"fileSize",
"fileState",
"fileType",
"hasSubversions",
"height",
"id",
"isArchived",
"isConvertible",
"isDownloadLocked",
"isMainVersion",
"isRotatable",
"keywords",
"keywordsRecognition",
"languageCodes",
"licenseReleases",
"location",
"md5sum",
"modelReleases",
"modifyDate",
"orientation",
"pixel",
"propertyReleases",
"rating",
"rotation",
"staticCollections",
"subject",
"uploadDate",
"user",
"versions",
"width"
],
"example": "all",
"title": "DefaultMetadataField",
"type": "string"
},
"type": "array"
}
},
"title": "SpaceModifiedDefaultMetadataFields",
"type": "object"
},
"SpaceModifiedDownloadFormatsAdded": {
"properties": {
"downloadFormatsAdded": {
"$ref": "#/components/schemas/ArraySchema_3464386466"
}
},
"title": "SpaceModifiedDownloadFormatsAdded",
"type": "object"
},
"SpaceModifiedDownloadFormatsRemoved": {
"properties": {
"downloadFormatsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3434343239"
}
},
"title": "SpaceModifiedDownloadFormatsRemoved",
"type": "object"
},
"SpaceModifiedFaviconImage": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SpaceModifiedFaviconImage",
"type": "object"
},
"SpaceModifiedForceDownloadProof": {
"properties": {
"newForceDownloadProof": {
"description": "The new forceDownloadProof-flag.",
"type": "boolean"
},
"oldForceDownloadProof": {
"description": "The old forceDownloadProof-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedForceDownloadProof",
"type": "object"
},
"SpaceModifiedForceWatermark": {
"properties": {
"newForceWatermark": {
"description": "The new forceWatermark-flag.",
"type": "boolean"
},
"oldForceWatermark": {
"description": "The old forceWatermark-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedForceWatermark",
"type": "object"
},
"SpaceModifiedHostNames": {
"properties": {
"newHostNames": {
"items": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"type": "array"
},
"oldHostNames": {
"items": {
"description": "A host name.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"type": "array"
}
},
"title": "SpaceModifiedHostNames",
"type": "object"
},
"SpaceModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedIsActive",
"type": "object"
},
"SpaceModifiedLanguagesAdded": {
"properties": {
"languagesAdded": {
"$ref": "#/components/schemas/ArraySchema_3739343737"
}
},
"title": "SpaceModifiedLanguagesAdded",
"type": "object"
},
"SpaceModifiedLanguagesRemoved": {
"properties": {
"languagesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3035643235"
}
},
"title": "SpaceModifiedLanguagesRemoved",
"type": "object"
},
"SpaceModifiedLicenseReleaseIDs": {
"properties": {
"licenseReleaseIDsAdded": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"licenseReleaseIDsRemoved": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "SpaceModifiedLicenseReleaseIDs",
"type": "object"
},
"SpaceModifiedLoginBackgroundImage": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SpaceModifiedLoginBackgroundImage",
"type": "object"
},
"SpaceModifiedLoginHeadline": {
"properties": {
"newLoginHeadline": {
"type": "string"
},
"oldLoginHeadline": {
"type": "string"
}
},
"title": "SpaceModifiedLoginHeadline",
"type": "object"
},
"SpaceModifiedLoginRequired": {
"properties": {
"newLoginRequired": {
"description": "The new LoginRequired-flag.",
"type": "boolean"
},
"oldLoginRequired": {
"description": "The old LoginRequired-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedLoginRequired",
"type": "object"
},
"SpaceModifiedLogoDarkImage": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SpaceModifiedLogoDarkImage",
"type": "object"
},
"SpaceModifiedLogoLightImage": {
"properties": {
"newUseCustomFile": {
"description": "Whether a custom file will be used from now on.",
"type": "boolean"
},
"oldUseCustomFile": {
"description": "Whether a custom file has been used.",
"type": "boolean"
}
},
"title": "SpaceModifiedLogoLightImage",
"type": "object"
},
"SpaceModifiedMainHostName": {
"properties": {
"newMainHostName": {
"description": "The bew mainHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
},
"oldMainHostName": {
"description": "The old mainHostName.",
"example": "www.pixx.io",
"title": "HostName",
"type": "string"
}
},
"title": "SpaceModifiedMainHostName",
"type": "object"
},
"SpaceModifiedModelReleaseIDs": {
"properties": {
"modelReleaseIDsAdded": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"modelReleaseIDsRemoved": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "SpaceModifiedModelReleaseIDs",
"type": "object"
},
"SpaceModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceModifiedName",
"type": "object"
},
"SpaceModifiedOriginalDownloadFormatTypesAdded": {
"properties": {
"originalDownloadFormatTypesAdded": {
"$ref": "#/components/schemas/ArraySchema_6339343636"
}
},
"title": "SpaceModifiedOriginalDownloadFormatTypesAdded",
"type": "object"
},
"SpaceModifiedOriginalDownloadFormatTypesRemoved": {
"properties": {
"originalDownloadFormatTypesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3561636530"
}
},
"title": "SpaceModifiedOriginalDownloadFormatTypesRemoved",
"type": "object"
},
"SpaceModifiedPermissionGroupsAdded": {
"properties": {
"permissionGroupsAdded": {
"$ref": "#/components/schemas/ArraySchema_3438636236"
}
},
"title": "SpaceModifiedPermissionGroupsAdded",
"type": "object"
},
"SpaceModifiedPermissionGroupsRemoved": {
"properties": {
"permissionGroupsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6630303262"
}
},
"title": "SpaceModifiedPermissionGroupsRemoved",
"type": "object"
},
"SpaceModifiedPreferredTitle": {
"properties": {
"newPreferredTitle": {
"$ref": "#/components/schemas/PortalTitleObject"
},
"oldPreferredTitle": {
"$ref": "#/components/schemas/PortalTitleObject"
}
},
"title": "SpaceModifiedPreferredTitle",
"type": "object"
},
"SpaceModifiedPrimaryColor": {
"properties": {
"newPrimaryColor": {
"description": "The new primaryColor-hexColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldPrimaryColor": {
"description": "The old primaryColor-hexColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SpaceModifiedPrimaryColor",
"type": "object"
},
"SpaceModifiedPropertyReleaseIDs": {
"properties": {
"propertyReleaseIDsAdded": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"propertyReleaseIDsRemoved": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "SpaceModifiedPropertyReleaseIDs",
"type": "object"
},
"SpaceModifiedSearchFieldsAdded": {
"properties": {
"searchFieldsAdded": {
"$ref": "#/components/schemas/ArraySchema_6163373163"
}
},
"title": "SpaceModifiedSearchFieldsAdded",
"type": "object"
},
"SpaceModifiedSearchFieldsRemoved": {
"properties": {
"searchFieldsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3639323535"
}
},
"title": "SpaceModifiedSearchFieldsRemoved",
"type": "object"
},
"SpaceModifiedSecondaryColor": {
"properties": {
"newSecondaryColor": {
"description": "The new secondaryColor-hexColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"oldSecondaryColor": {
"description": "The old secondaryColor-hexColor.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
}
},
"title": "SpaceModifiedSecondaryColor",
"type": "object"
},
"SpaceModifiedShowAllLicenseReleases": {
"properties": {
"newShowAllLicenseReleases": {
"type": "boolean"
},
"oldShowAllLicenseReleases": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowAllLicenseReleases",
"type": "object"
},
"SpaceModifiedShowAllModelReleases": {
"properties": {
"newShowAllModelReleases": {
"type": "boolean"
},
"oldShowAllModelReleases": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowAllModelReleases",
"type": "object"
},
"SpaceModifiedShowAllPropertyReleases": {
"properties": {
"newShowAllPropertyReleases": {
"type": "boolean"
},
"oldShowAllPropertyReleases": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowAllPropertyReleases",
"type": "object"
},
"SpaceModifiedShowFileType": {
"properties": {
"newShowFileType": {
"type": "boolean"
},
"oldShowFileType": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowFileType",
"type": "object"
},
"SpaceModifiedShowLicenseReleaseFile": {
"properties": {
"newShowLicenseReleaseFile": {
"type": "boolean"
},
"oldShowLicenseReleaseFile": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowLicenseReleaseFile",
"type": "object"
},
"SpaceModifiedShowModelReleaseFile": {
"properties": {
"newShowModelReleaseFile": {
"type": "boolean"
},
"oldShowModelReleaseFile": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowModelReleaseFile",
"type": "object"
},
"SpaceModifiedShowPropertyReleaseFile": {
"properties": {
"newShowPropertyReleaseFile": {
"type": "boolean"
},
"oldShowPropertyReleaseFile": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowPropertyReleaseFile",
"type": "object"
},
"SpaceModifiedShowTermsOfUse": {
"properties": {
"newShowTermsOfUse": {
"type": "boolean"
},
"oldShowTermsOfUse": {
"type": "boolean"
}
},
"title": "SpaceModifiedShowTermsOfUse",
"type": "object"
},
"SpaceModifiedStandardMetadataIDs": {
"properties": {
"standardMetadataIDsAdded": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
},
"standardMetadataIDsRemoved": {
"items": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"type": "array"
}
},
"title": "SpaceModifiedStandardMetadataIDs",
"type": "object"
},
"SpaceModifiedStartScreenPage": {
"properties": {
"newStartScreenPage": {
"description": "The new startScreenPage-id.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldStartScreenPage": {
"description": "The old startScreenPage-id.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "SpaceModifiedStartScreenPage",
"type": "object"
},
"SpaceModifiedTermsOfUse": {
"properties": {
"newTermsOfUse": {
"type": "string"
},
"oldTermsOfUse": {
"type": "string"
}
},
"title": "SpaceModifiedTermsOfUse",
"type": "object"
},
"SpaceModifiedUseSSO": {
"properties": {
"newUseSSO": {
"description": "The new useSSO-flag.",
"type": "boolean"
},
"oldUseSSO": {
"description": "The old useSSO-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedUseSSO",
"type": "object"
},
"SpaceModifiedUseSemanticSearch": {
"properties": {
"newUseSemanticSearch": {
"description": "The new useSemanticSearch-flag.",
"type": "boolean"
},
"oldUseSemanticSearch": {
"description": "The old useSemanticSearch-flag.",
"type": "boolean"
}
},
"title": "SpaceModifiedUseSemanticSearch",
"type": "object"
},
"SpaceNavigationModifiedAnchor": {
"properties": {
"newAnchor": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldAnchor": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceNavigationModifiedAnchor",
"type": "object"
},
"SpaceNavigationModifiedFooterFooterText": {
"properties": {
"newFooterText": {
"type": "string"
},
"oldFooterText": {
"type": "string"
}
},
"title": "SpaceNavigationModifiedFooterFooterText",
"type": "object"
},
"SpaceNavigationModifiedFooterName": {
"properties": {
"newName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceNavigationModifiedFooterName",
"type": "object"
},
"SpaceNavigationModifiedFooterOrder": {
"properties": {
"newOrder": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceNavigationModifiedFooterOrder",
"type": "object"
},
"SpaceNavigationModifiedHeaderName": {
"properties": {
"newName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceNavigationModifiedHeaderName",
"type": "object"
},
"SpaceNavigationModifiedHeaderOrder": {
"properties": {
"newOrder": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldOrder": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpaceNavigationModifiedHeaderOrder",
"type": "object"
},
"SpaceNavigationModifiedLink": {
"properties": {
"newLink": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldLink": {
"description": "An URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "SpaceNavigationModifiedLink",
"type": "object"
},
"SpaceNavigationModifiedSpacePageID": {
"properties": {
"newSpacePageID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldSpacePageID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "SpaceNavigationModifiedSpacePageID",
"type": "object"
},
"SpacePageModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpacePageModifiedName",
"type": "object"
},
"SpacePageModifiedSlug": {
"properties": {
"newSlug": {
"description": "The new slug.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSlug": {
"description": "The old slug.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SpacePageModifiedSlug",
"type": "object"
},
"SpacePageTemplateUpdated": {
"properties": {
"contentModified": {
"description": "Whether the content json of this spacePageTemplate was rewritten.",
"type": "boolean"
},
"newDescription": {
"description": "The new description, only set when the description changed.",
"type": "string"
},
"newName": {
"description": "The new name, only set when the name changed.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newPreviewImageLarge": {
"description": "The new url of the large preview image, only set when it changed.",
"type": "string"
},
"newPreviewImageSmall": {
"description": "The new url of the small preview image, only set when it changed.",
"type": "string"
},
"oldDescription": {
"description": "The old description, only set when the description changed.",
"type": "string"
},
"oldName": {
"description": "The old name, only set when the name changed.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldPreviewImageLarge": {
"description": "The old url of the large preview image, only set when it changed.",
"type": "string"
},
"oldPreviewImageSmall": {
"description": "The old url of the small preview image, only set when it changed.",
"type": "string"
}
},
"title": "SpacePageTemplateUpdated",
"type": "object"
},
"SpaceTemplateUpdated": {
"properties": {
"newDescription": {
"description": "The new description, only set when the description changed.",
"type": "string"
},
"newName": {
"description": "The new name, only set when the name changed.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newPreviewImageLarge": {
"description": "The new url of the large preview image, only set when it changed.",
"type": "string"
},
"newPreviewImageSmall": {
"description": "The new url of the small preview image, only set when it changed.",
"type": "string"
},
"oldDescription": {
"description": "The old description, only set when the description changed.",
"type": "string"
},
"oldName": {
"description": "The old name, only set when the name changed.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldPreviewImageLarge": {
"description": "The old url of the large preview image, only set when it changed.",
"type": "string"
},
"oldPreviewImageSmall": {
"description": "The old url of the small preview image, only set when it changed.",
"type": "string"
},
"pageTemplatesAdded": {
"$ref": "#/components/schemas/ArraySchema_3464306138"
},
"pageTemplatesRemoved": {
"$ref": "#/components/schemas/ArraySchema_6164633031"
}
},
"title": "SpaceTemplateUpdated",
"type": "object"
},
"StandardMetadata": {
"properties": {
"editType": {
"description": "A metadata field edit type.",
"enum": [
"date",
"focalpoint",
"language",
"map",
"multiselection",
"none",
"number",
"orientation",
"selection",
"text"
],
"example": "none",
"title": "MetadataFieldEditType",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"metadataType": {
"enum": [
"custom",
"exif",
"internal",
"iptc",
"standard",
"xmp"
],
"example": "custom",
"title": "MetadataOption",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "StandardMetadata",
"type": "object"
},
"StandardMetadataModifiedValue": {
"properties": {
"id": {
"description": "The ID of the modified value.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"newValue": {
"description": "The new value.",
"type": "object"
},
"oldValue": {
"description": "The old value.",
"type": "object"
}
},
"title": "StandardMetadataModifiedValue",
"type": "object"
},
"StandardMetadataModifiedValueType": {
"properties": {
"newValueType": {
"description": "The new valuetype.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldValueType": {
"description": "The old valuetype.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "StandardMetadataModifiedValueType",
"type": "object"
},
"Synonym": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"synonym1": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym10": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym11": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym12": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym13": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym14": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym15": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym16": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym17": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym18": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym19": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym2": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym20": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym3": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym4": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym5": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym6": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym7": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym8": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"synonym9": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "Synonym",
"type": "object"
},
"SynonymColumns": {
"properties": {
"column1": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column10": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column11": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column12": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column13": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column14": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column15": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column16": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column17": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column18": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column19": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column2": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column20": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column3": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column4": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column5": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column6": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column7": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column8": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"column9": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "SynonymColumns",
"type": "object"
},
"SynonymColumnsModifiedSynonym1": {
"properties": {
"newSynonym1": {
"description": "The new synonym1.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym1": {
"description": "The old synonym1.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym1",
"type": "object"
},
"SynonymColumnsModifiedSynonym10": {
"properties": {
"newSynonym10": {
"description": "The new synonym10.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym10": {
"description": "The old synonym10.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym10",
"type": "object"
},
"SynonymColumnsModifiedSynonym11": {
"properties": {
"newSynonym11": {
"description": "The new synonym11.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym11": {
"description": "The old synonym11.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym11",
"type": "object"
},
"SynonymColumnsModifiedSynonym12": {
"properties": {
"newSynonym12": {
"description": "The new synonym12.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym12": {
"description": "The old synonym12.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym12",
"type": "object"
},
"SynonymColumnsModifiedSynonym13": {
"properties": {
"newSynonym13": {
"description": "The new synonym13.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym13": {
"description": "The old synonym13.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym13",
"type": "object"
},
"SynonymColumnsModifiedSynonym14": {
"properties": {
"newSynonym14": {
"description": "The new synonym14.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym14": {
"description": "The old synonym14.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym14",
"type": "object"
},
"SynonymColumnsModifiedSynonym15": {
"properties": {
"newSynonym15": {
"description": "The new synonym15.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym15": {
"description": "The old synonym15.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym15",
"type": "object"
},
"SynonymColumnsModifiedSynonym16": {
"properties": {
"newSynonym16": {
"description": "The new synonym16.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym16": {
"description": "The old synonym16.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym16",
"type": "object"
},
"SynonymColumnsModifiedSynonym17": {
"properties": {
"newSynonym17": {
"description": "The new synonym17.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym17": {
"description": "The old synonym17.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym17",
"type": "object"
},
"SynonymColumnsModifiedSynonym18": {
"properties": {
"newSynonym18": {
"description": "The new synonym18.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym18": {
"description": "The old synonym18.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym18",
"type": "object"
},
"SynonymColumnsModifiedSynonym19": {
"properties": {
"newSynonym19": {
"description": "The new synonym19.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym19": {
"description": "The old synonym19.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym19",
"type": "object"
},
"SynonymColumnsModifiedSynonym2": {
"properties": {
"newSynonym2": {
"description": "The new synonym2.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym2": {
"description": "The old synonym2.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym2",
"type": "object"
},
"SynonymColumnsModifiedSynonym20": {
"properties": {
"newSynonym20": {
"description": "The new synonym20.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym20": {
"description": "The old synonym20.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym20",
"type": "object"
},
"SynonymColumnsModifiedSynonym3": {
"properties": {
"newSynonym3": {
"description": "The new synonym3.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym3": {
"description": "The old synonym3.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym3",
"type": "object"
},
"SynonymColumnsModifiedSynonym4": {
"properties": {
"newSynonym4": {
"description": "The new synonym4.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym4": {
"description": "The old synonym4.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym4",
"type": "object"
},
"SynonymColumnsModifiedSynonym5": {
"properties": {
"newSynonym5": {
"description": "The new synonym5.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym5": {
"description": "The old synonym5.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym5",
"type": "object"
},
"SynonymColumnsModifiedSynonym6": {
"properties": {
"newSynonym6": {
"description": "The new synonym6.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym6": {
"description": "The old synonym6.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym6",
"type": "object"
},
"SynonymColumnsModifiedSynonym7": {
"properties": {
"newSynonym7": {
"description": "The new synonym7.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym7": {
"description": "The old synonym7.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym7",
"type": "object"
},
"SynonymColumnsModifiedSynonym8": {
"properties": {
"newSynonym8": {
"description": "The new synonym8.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym8": {
"description": "The old synonym8.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym8",
"type": "object"
},
"SynonymColumnsModifiedSynonym9": {
"properties": {
"newSynonym9": {
"description": "The new synonym9.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym9": {
"description": "The old synonym9.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymColumnsModifiedSynonym9",
"type": "object"
},
"SynonymModifiedSynonym": {
"properties": {
"column": {
"description": "The column.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"newSynonym": {
"description": "The new synonym.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldSynonym": {
"description": "The old synonym.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "SynonymModifiedSynonym",
"type": "object"
},
"TenantModifiedAdditionalDiskSpaceGigaByte": {
"properties": {
"newAdditionalDiskSpaceGigaByte": {
"description": "The new additionalDiskSpaceGigaByte.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldAdditionalDiskSpaceGigaByte": {
"description": "The old additionalDiskSpaceGigaByte.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedAdditionalDiskSpaceGigaByte",
"type": "object"
},
"TenantModifiedExpirationDate": {
"properties": {
"newExpirationDate": {
"description": "The new expirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldExpirationDate": {
"description": "The old expirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedExpirationDate",
"type": "object"
},
"TenantModifiedIsPaused": {
"properties": {
"newIsPaused": {
"description": "The new isPaused.",
"type": "boolean"
},
"oldIsPaused": {
"description": "The old isPaused.",
"type": "boolean"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedIsPaused",
"type": "object"
},
"TenantModifiedMediaPortalLimit": {
"properties": {
"newMediaPortalLimit": {
"$ref": "#/components/schemas/ObjectSchema_3665333539"
},
"oldMediaPortalLimit": {
"$ref": "#/components/schemas/ObjectSchema_3232663839"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedMediaPortalLimit",
"type": "object"
},
"TenantModifiedReadOnlyUserLimit": {
"properties": {
"newReadOnlyUserLimit": {
"description": "The new readOnlyUserLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldReadOnlyUserLimit": {
"description": "The old readOnlyUserLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedReadOnlyUserLimit",
"type": "object"
},
"TenantModifiedUserLimit": {
"properties": {
"newUserLimit": {
"description": "The new userLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"oldUserLimit": {
"description": "The old userLimit.",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"systemIdentifier": {
"description": "The identifier of the system.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "TenantModifiedUserLimit",
"type": "object"
},
"TrashCreated": {
"properties": {
"fileID": {
"description": "The id of the file that was moved to the trash.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "TrashCreated",
"type": "object"
},
"TrashRestored": {
"properties": {
"fileIDsRestored": {
"$ref": "#/components/schemas/ArraySchema_6337626261"
}
},
"title": "TrashRestored",
"type": "object"
},
"UploadLink": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"directory": {
"$ref": "#/components/schemas/DirectoryBasic"
},
"diskSpaceExceeded": {
"type": "boolean"
},
"displayUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"emails": {
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"type": "array"
},
"expirationDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"faceRecognitionDisabled": {
"type": "boolean"
},
"fileState": {
"$ref": "#/components/schemas/FileStateBasic"
},
"filesQuantity": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"isDisabled": {
"type": "boolean"
},
"keywords": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseBasic"
},
"type": "array"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseBasic"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"type": "string"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
},
"type": "array"
},
"remainingFileUploads": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"showAllLicenseReleases": {
"type": "boolean"
},
"showAllModelReleases": {
"type": "boolean"
},
"showAllPropertyReleases": {
"type": "boolean"
},
"showLicenseReleaseFile": {
"type": "boolean"
},
"showModelReleaseFile": {
"type": "boolean"
},
"showPropertyReleaseFile": {
"type": "boolean"
},
"uploadCondition": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"validityPeriod": {
"description": "The validity period of the external share.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"title": "UploadLink",
"type": "object"
},
"UploadLinkFileUploaded": {
"properties": {
"fileID": {
"description": "The ID of the file that was uploaded.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"uploadLinkGuestUserEmail": {
"description": "The email that the uploadLink guest user specified.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"uploadLinkGuestUserName": {
"description": "The name that the uploadLink guest user specified.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UploadLinkFileUploaded",
"type": "object"
},
"UploadLinkInfo": {
"description": "The new uploadLink.",
"example": {
"guestUserEmail": "technik@pixx.io",
"guestUserName": "guest1",
"uploadLinkID": 1
},
"properties": {
"guestUserEmail": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"guestUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"uploadLinkID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UploadLinkInfo",
"type": "object"
},
"UploadLinkInfo_3863373266": {
"description": "The old uploadLink.",
"example": {
"guestUserEmail": "technik@pixx.io",
"guestUserName": "guest1",
"uploadLinkID": 1
},
"properties": {
"guestUserEmail": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"guestUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"uploadLinkID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UploadLinkInfo",
"type": "object"
},
"UploadLinkModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "UploadLinkModifiedDescription",
"type": "object"
},
"UploadLinkModifiedDirectoryID": {
"properties": {
"newDirectoryID": {
"description": "The new directoryID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldDirectoryID": {
"description": "The old directoryID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UploadLinkModifiedDirectoryID",
"type": "object"
},
"UploadLinkModifiedEmailsAdded": {
"properties": {
"emailsAdded": {
"$ref": "#/components/schemas/ArraySchema_6662666538"
}
},
"title": "UploadLinkModifiedEmailsAdded",
"type": "object"
},
"UploadLinkModifiedFaceRecognitionDisabled": {
"properties": {
"newFaceRecognitionDisabled": {
"description": "The new face recognition disabled flag",
"type": "boolean"
},
"oldFaceRecognitionDisabled": {
"description": "The old face recognition disabled flag",
"type": "boolean"
}
},
"title": "UploadLinkModifiedFaceRecognitionDisabled",
"type": "object"
},
"UploadLinkModifiedFileStateID": {
"properties": {
"newFileStateID": {
"description": "The new fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldFileStateID": {
"description": "The old fileStateID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UploadLinkModifiedFileStateID",
"type": "object"
},
"UploadLinkModifiedFilesAdded": {
"properties": {
"filesAdded": {
"$ref": "#/components/schemas/ArraySchema_6431616537"
}
},
"title": "UploadLinkModifiedFilesAdded",
"type": "object"
},
"UploadLinkModifiedFilesRemoved": {
"properties": {
"filesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3263613436"
}
},
"title": "UploadLinkModifiedFilesRemoved",
"type": "object"
},
"UploadLinkModifiedIsDisabled": {
"properties": {
"newIsDisabled": {
"description": "The new isDisabled-flag.",
"type": "boolean"
},
"oldIsDisabled": {
"description": "The old isDisabled-flag.",
"type": "boolean"
}
},
"title": "UploadLinkModifiedIsDisabled",
"type": "object"
},
"UploadLinkModifiedKeywordsAdded": {
"properties": {
"keywordsAdded": {
"$ref": "#/components/schemas/ArraySchema_6233343262"
}
},
"title": "UploadLinkModifiedKeywordsAdded",
"type": "object"
},
"UploadLinkModifiedKeywordsRemoved": {
"properties": {
"keywordsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3266373361"
}
},
"title": "UploadLinkModifiedKeywordsRemoved",
"type": "object"
},
"UploadLinkModifiedLicenseReleaseIDsAdded": {
"properties": {
"licenseReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3438326230"
}
},
"title": "UploadLinkModifiedLicenseReleaseIDsAdded",
"type": "object"
},
"UploadLinkModifiedLicenseReleaseIDsRemoved": {
"properties": {
"licenseReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema"
}
},
"title": "UploadLinkModifiedLicenseReleaseIDsRemoved",
"type": "object"
},
"UploadLinkModifiedModelReleaseIDsAdded": {
"properties": {
"modelReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6430343739"
}
},
"title": "UploadLinkModifiedModelReleaseIDsAdded",
"type": "object"
},
"UploadLinkModifiedModelReleaseIDsRemoved": {
"properties": {
"modelReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_6638656432"
}
},
"title": "UploadLinkModifiedModelReleaseIDsRemoved",
"type": "object"
},
"UploadLinkModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UploadLinkModifiedName",
"type": "object"
},
"UploadLinkModifiedNotificationText": {
"properties": {
"newNotificationText": {
"description": "The new notificationText.",
"type": "string"
},
"oldNotificationText": {
"description": "The old notificationText.",
"type": "string"
}
},
"title": "UploadLinkModifiedNotificationText",
"type": "object"
},
"UploadLinkModifiedPropertyReleaseIDsAdded": {
"properties": {
"propertyReleaseIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_3939316139"
}
},
"title": "UploadLinkModifiedPropertyReleaseIDsAdded",
"type": "object"
},
"UploadLinkModifiedPropertyReleaseIDsRemoved": {
"properties": {
"propertyReleaseIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3139333730"
}
},
"title": "UploadLinkModifiedPropertyReleaseIDsRemoved",
"type": "object"
},
"UploadLinkModifiedShowAllLicenseReleases": {
"properties": {
"newShowAllLicenseReleases": {
"description": "The new showAllLicenseReleases-flag.",
"type": "boolean"
},
"oldShowAllLicenseReleases": {
"description": "The old showAllLicenseReleases-flag.",
"type": "boolean"
}
},
"title": "UploadLinkModifiedShowAllLicenseReleases",
"type": "object"
},
"UploadLinkModifiedShowAllModelReleases": {
"properties": {
"newShowAllModelReleases": {
"description": "The new showAllModelReleases-flag.",
"type": "boolean"
},
"oldShowAllModelReleases": {
"description": "The old showAllModelReleases-flag.",
"type": "boolean"
}
},
"title": "UploadLinkModifiedShowAllModelReleases",
"type": "object"
},
"UploadLinkModifiedShowAllPropertyReleases": {
"properties": {
"newShowAllPropertyReleases": {
"description": "The new showAllPropertyReleases-flag.",
"type": "boolean"
},
"oldShowAllPropertyReleases": {
"description": "The old showAllPropertyReleases-flag.",
"type": "boolean"
}
},
"title": "UploadLinkModifiedShowAllPropertyReleases",
"type": "object"
},
"UploadLinkModifiedUploadCondition": {
"properties": {
"newUploadCondition": {
"description": "The new uploadCondition.",
"type": "string"
},
"oldUploadCondition": {
"description": "The old uploadCondition.",
"type": "string"
}
},
"title": "UploadLinkModifiedUploadCondition",
"type": "object"
},
"UploadLinkModifiedUserID": {
"properties": {
"newUserID": {
"description": "The new userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserID": {
"description": "The old userID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UploadLinkModifiedUserID",
"type": "object"
},
"UploadLinkModifiedValidityPeriod": {
"properties": {
"newValidityPeriod": {
"description": "The new validityPeriod.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
},
"oldValidityPeriod": {
"description": "The old validityPeriod.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"title": "UploadLinkModifiedValidityPeriod",
"type": "object"
},
"UploadLink_6666316563": {
"description": "The uploadLink.",
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"directory": {
"$ref": "#/components/schemas/DirectoryBasic"
},
"diskSpaceExceeded": {
"type": "boolean"
},
"displayUserName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"emails": {
"items": {
"$ref": "#/components/schemas/EmailLanguage"
},
"type": "array"
},
"expirationDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"faceRecognitionDisabled": {
"type": "boolean"
},
"fileState": {
"$ref": "#/components/schemas/FileStateBasic"
},
"filesQuantity": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"isDisabled": {
"type": "boolean"
},
"keywords": {
"items": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"type": "array"
},
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseReleaseBasic"
},
"type": "array"
},
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelReleaseBasic"
},
"type": "array"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"type": "string"
},
"propertyReleases": {
"items": {
"$ref": "#/components/schemas/PropertyReleaseBasic"
},
"type": "array"
},
"remainingFileUploads": {
"description": "A positive integer bigger than or equal to zero with valid zero value \"0\".",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"showAllLicenseReleases": {
"type": "boolean"
},
"showAllModelReleases": {
"type": "boolean"
},
"showAllPropertyReleases": {
"type": "boolean"
},
"showLicenseReleaseFile": {
"type": "boolean"
},
"showModelReleaseFile": {
"type": "boolean"
},
"showPropertyReleaseFile": {
"type": "boolean"
},
"uploadCondition": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"validityPeriod": {
"description": "The validity period of the external share.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"title": "UploadLink",
"type": "object"
},
"UploadObligation": {
"description": "The upload obligation for a permission group.",
"example": {
"noticeText": "abc",
"type": "subject"
},
"properties": {
"importantMetadataID": {
"type": "integer"
},
"maximum": {
"type": "integer"
},
"minimum": {
"type": "integer"
},
"noticeText": {
"type": "string"
},
"type": {
"description": "The type of the UploadObligation",
"enum": [
"collection",
"description",
"importantMetadata",
"keywords",
"license",
"model",
"property",
"subject"
],
"example": "keywords",
"title": "UploadObligationType",
"type": "string"
}
},
"title": "UploadObligation",
"type": "object"
},
"User": {
"properties": {
"apiKeys": {
"items": {
"$ref": "#/components/schemas/APIKeyBasic"
},
"type": "array"
},
"azureActiveDirectoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"directoryPermissions": {
"$ref": "#/components/schemas/PermissionGroupDirectoryPermissions"
},
"displayName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"downloadFormatPermissions": {
"$ref": "#/components/schemas/PermissionGroupDownloadFormatPermissions"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"externalID": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"externalTargetEmail": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"fileStatePermissions": {
"$ref": "#/components/schemas/PermissionGroupFileStatePermissions"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"homeDirectory": {
"$ref": "#/components/schemas/DirectoryBasic"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isExternal": {
"type": "boolean"
},
"isLinked": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"isSupportUser": {
"type": "boolean"
},
"language": {
"description": "language",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"permissionGroups": {
"items": {
"$ref": "#/components/schemas/PermissionGroupBasic"
},
"type": "array"
},
"permissions": {
"$ref": "#/components/schemas/PermissionGroupPermissions"
},
"refreshToken": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"twoFactorAuthSetUp": {
"type": "boolean"
},
"uploadMandatoryDefaultMetadataFields": {
"items": {
"$ref": "#/components/schemas/MandatoryDefaultMetadataField"
},
"type": "array"
},
"uploadObligations": {
"items": {
"$ref": "#/components/schemas/UploadObligation"
},
"type": "array"
},
"userName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "User",
"type": "object"
},
"UserBasic": {
"properties": {
"apiKeys": {
"items": {
"$ref": "#/components/schemas/APIKeyBasic"
},
"type": "array"
},
"displayName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"externalID": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"userName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "UserBasic",
"type": "object"
},
"UserBasic_3765633131": {
"description": "The owner of the file.",
"properties": {
"apiKeys": {
"items": {
"$ref": "#/components/schemas/APIKeyBasic"
},
"type": "array"
},
"displayName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"externalID": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"userName": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "UserBasic",
"type": "object"
},
"UserInfo": {
"description": "The user.",
"example": {
"id": 1,
"name": "name",
"type": "user"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"type": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
}
},
"title": "UserInfo",
"type": "object"
},
"UserInfo_6263373834": {
"description": "UserInfo is a struct which contains the information of a user.",
"example": {
"id": 1,
"name": "name",
"type": "user"
},
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "A Username",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"type": {
"enum": [
"administration",
"externalshareuser",
"generalportal",
"guest",
"portal",
"space",
"uploadlink",
"user"
],
"example": "user",
"title": "UserType",
"type": "string"
}
},
"title": "UserInfo",
"type": "object"
},
"UserModifiedEmail": {
"properties": {
"newEmail": {
"description": "The new email.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"oldEmail": {
"description": "The old email.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
},
"title": "UserModifiedEmail",
"type": "object"
},
"UserModifiedFirstName": {
"properties": {
"newFirstName": {
"description": "The new firstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldFirstName": {
"description": "The old firstName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UserModifiedFirstName",
"type": "object"
},
"UserModifiedIsActive": {
"properties": {
"newIsActive": {
"description": "The new isActive-flag.",
"type": "boolean"
},
"oldIsActive": {
"description": "The old isActive-flag.",
"type": "boolean"
}
},
"title": "UserModifiedIsActive",
"type": "object"
},
"UserModifiedIsExternal": {
"properties": {
"newIsExternal": {
"description": "The new isExternal-flag.",
"type": "boolean"
},
"oldIsExternal": {
"description": "The old isExternal-flag.",
"type": "boolean"
}
},
"title": "UserModifiedIsExternal",
"type": "object"
},
"UserModifiedLanguage": {
"properties": {
"newLanguage": {
"description": "The new language.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"oldLanguage": {
"description": "The old language.",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
}
},
"title": "UserModifiedLanguage",
"type": "object"
},
"UserModifiedLastName": {
"properties": {
"newLastName": {
"description": "The new lastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldLastName": {
"description": "The old lastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UserModifiedLastName",
"type": "object"
},
"UserModifiedLinked": {
"properties": {
"id": {
"description": "The ID of the linked Identity Manager.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the linked Identity Manager.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UserModifiedLinked",
"type": "object"
},
"UserModifiedPermissionGroupIDsAdded": {
"properties": {
"permissionGroupIDsAdded": {
"$ref": "#/components/schemas/ArraySchema_6432616539"
}
},
"title": "UserModifiedPermissionGroupIDsAdded",
"type": "object"
},
"UserModifiedPermissionGroupIDsRemoved": {
"properties": {
"permissionGroupIDsRemoved": {
"$ref": "#/components/schemas/ArraySchema_3539653435"
}
},
"title": "UserModifiedPermissionGroupIDsRemoved",
"type": "object"
},
"UserModifiedRefreshToken": {
"properties": {
"newRefreshToken": {
"description": "The new refreshToken.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldRefreshToken": {
"description": "The old refreshToken.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "UserModifiedRefreshToken",
"type": "object"
},
"UserModifiedResetPasswordStamp": {
"properties": {
"newResetPasswordStamp": {
"description": "The new resetPasswordStamp.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldResetPasswordStamp": {
"description": "The old resetPasswordStamp.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "UserModifiedResetPasswordStamp",
"type": "object"
},
"UserModifiedResetPasswordToken": {
"properties": {
"newResetPasswordToken": {
"description": "The new resetPasswordToken.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"oldResetPasswordToken": {
"description": "The old resetPasswordToken.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
"title": "UserModifiedResetPasswordToken",
"type": "object"
},
"UserModifiedSecretExpirationDate": {
"properties": {
"newSecretExpirationDate": {
"description": "The new secretExpirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldSecretExpirationDate": {
"description": "The old secretExpirationDate.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "UserModifiedSecretExpirationDate",
"type": "object"
},
"UserModifiedTwoFactorAuthSetUp": {
"properties": {
"newTwoFactorAuthSetUp": {
"description": "The new twoFactorAuthSetUp.",
"type": "boolean"
},
"oldTwoFactorAuthSetUp": {
"description": "The old twoFactorAuthSetUp.",
"type": "boolean"
}
},
"title": "UserModifiedTwoFactorAuthSetUp",
"type": "object"
},
"UserModifiedUnlinked": {
"properties": {
"id": {
"description": "The ID of the unlinked Identity Manager.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "The name of the unlinked Identity Manager.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "UserModifiedUnlinked",
"type": "object"
},
"UserModifiedUserName": {
"properties": {
"newUserName": {
"description": "The new userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
},
"oldUserName": {
"description": "The old userName.",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"title": "UserModifiedUserName",
"type": "object"
},
"UserTrackingModifiedFirstMonthlyLogin": {
"properties": {
"newFirstMonthlyLogin": {
"description": "The new firstmonthlylogin.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"oldFirstMonthlyLogin": {
"description": "The old firstmonthlylogin.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
}
},
"title": "UserTrackingModifiedFirstMonthlyLogin",
"type": "object"
},
"UserTrackingModifiedUserID": {
"properties": {
"newUserID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"oldUserID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"title": "UserTrackingModifiedUserID",
"type": "object"
},
"VariantStack": {
"properties": {
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"modifyDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "VariantStack",
"type": "object"
},
"VariantStackBasic": {
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "VariantStackBasic",
"type": "object"
},
"VariantStackInfo": {
"description": "The old variantStack.",
"example": {
"variantStackID": 1,
"variantStackLinkName": "variant stack 1"
},
"properties": {
"variantStackID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"variantStackLinkName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "VariantStackInfo",
"type": "object"
},
"VariantStackInfo_6632396365": {
"description": "The new variantStack.",
"example": {
"variantStackID": 1,
"variantStackLinkName": "variant stack 1"
},
"properties": {
"variantStackID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"variantStackLinkName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "VariantStackInfo",
"type": "object"
},
"VariantStackModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "VariantStackModifiedDescription",
"type": "object"
},
"VariantStackModifiedFilesAdded": {
"properties": {
"filesAdded": {
"$ref": "#/components/schemas/ArraySchema_3131366263"
}
},
"title": "VariantStackModifiedFilesAdded",
"type": "object"
},
"VariantStackModifiedFilesRemoved": {
"properties": {
"filesRemoved": {
"$ref": "#/components/schemas/ArraySchema_3766376639"
}
},
"title": "VariantStackModifiedFilesRemoved",
"type": "object"
},
"VariantStackModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "VariantStackModifiedName",
"type": "object"
},
"VersionsForFile": {
"properties": {
"mainVersion": {
"$ref": "#/components/schemas/FileInfo"
},
"subVersions": {
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
}
},
"title": "VersionsForFile",
"type": "object"
},
"WebhookModifiedDescription": {
"properties": {
"newDescription": {
"description": "The new description.",
"type": "string"
},
"oldDescription": {
"description": "The old description.",
"type": "string"
}
},
"title": "WebhookModifiedDescription",
"type": "object"
},
"WebhookModifiedEventKeysAdded": {
"properties": {
"eventKeysAdded": {
"$ref": "#/components/schemas/ArraySchema_3638366332"
}
},
"title": "WebhookModifiedEventKeysAdded",
"type": "object"
},
"WebhookModifiedEventKeysRemoved": {
"properties": {
"eventKeysRemoved": {
"$ref": "#/components/schemas/ArraySchema_3265336238"
}
},
"title": "WebhookModifiedEventKeysRemoved",
"type": "object"
},
"WebhookModifiedName": {
"properties": {
"newName": {
"description": "The new name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"oldName": {
"description": "The old name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"title": "WebhookModifiedName",
"type": "object"
},
"WebhookModifiedURL": {
"properties": {
"newURL": {
"description": "The new URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"oldURL": {
"description": "The old URL.",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
}
},
"title": "WebhookModifiedURL",
"type": "object"
},
"event": {
"$ref": "#/components/schemas/Event"
},
"eventOnlyApplication": {
"$ref": "#/components/schemas/EventOnlyApplication"
}
},
"securitySchemes": {
"Authorization": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
}
},
"info": {
"description": "\u003ca href=\"https://www.pixx.io/en/data-privacy-statement\" target=\"_blank\"\u003eData privacy statement\u003c/a\u003e ·\n\u003ca href=\"https://www.pixx.io/en/imprint\" target=\"_blank\"\u003eLegal notice\u003c/a\u003e\n\n\u0026nbsp;\n\n**Welcome to the Documentation of the pixx.io REST API!**\n\nThe API provides a collection of HTTP endpoints, that can be used for creating, updating, and retrieving data within your pixx.io workspace.\nThe API expects PUT and POST requests to be of the content-type application/json or application/x-www-form-urlencoded unless you send a file with the requests, in which case it has to be a multipart/form-data request.\nAll API responses are in JSON.\nThis documentation serves as a comprehensive guide to help you integrate with the API and leverage its functionalities to enhance your applications and workflows.\nThe following sections explain some basic concepts about the API, further down you find all available endpoints and their documentation.\n\n# General Information\n\n\u003cdetails\u003e\n  \u003csummary\u003eAuthentication\u003c/summary\u003e\n\n  \u003ch2\u003eAuthentication\u003c/h2\u003e\n\n  \u003cp\u003epixx.io relies on \u003cstrong\u003eHTTP Bearer Authentication\u003c/strong\u003e for all API requests. The Token comes in the form of an API key, which can be obtained from within your Mediaspace (Settings → API → API-Key → Generate). In order to authenticate, the API Key needs to be sent with every API request in the Authorization Header like this: \u003ccode\u003eAuthorization: Bearer {your_api_key}\u003c/code\u003e. \u003cbr\u003eThe API Key is bound to the user that generated it, meaning that all requests (e.g. File Uploads or Downloads) are treated like they come from the user that generated the API Key.\u003cbr\u003e\u003c/p\u003e\n\n  \u003cp\u003eNote: Currently only pixx.io users with admin rights have the ability to create an API Key.\u003c/p\u003e\n\n  \u003ch3\u003eExample\u003c/h3\u003e\n  \u003cpre\u003ecurl --location \\\n'{your_mediaspace_url}/api/v1/collections?page=1\u0026pageSize=20' \\\n--header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n\n  \u003ch3\u003eTransition from Old Authentication\u003c/h3\u003e\n  \u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e \u003ci\u003eDuring the API Beta Phase, we were using a more complicated approach that involved a (Beta-)API-Key, Refresh- \u0026 AccessTokens.\u003c/i\u003e\u003c/p\u003e\n  \u003cp\u003e\u003ci\u003eThis approach has been deprecated in the meantime, please consider switching to Bearer Authentication.\u003c/i\u003e\u003c/p\u003e\n\n  \u003cp\u003eTo switch from the deprecated Refresh- \u0026 AccessToken authentication method to Bearer authentication, follow these steps :\u003c/p\u003e\n  \u003col\u003e\n    \u003cli\u003eCreate a Bearer Token using the API-Key Section in your pixx.io mediaspace.\u003c/li\u003e\n    \u003cli\u003eRemove any parts of your script that deal with RefreshToken and AccessToken.\u003c/li\u003e\n    \u003cli\u003eInstead of using AccessToken, use the new Bearer Token for your requests in the Authorization Header.\u003c/li\u003e\n  \u003c/ol\u003e\n  \u003cp\u003eRemember, the format of your request \"Authorization\"-header changes from \u003ccode\u003eKey {your_access_token}\u003c/code\u003e to \u003ccode\u003eBearer {your_api_key}\u003c/code\u003e during this transition.\u003c/p\u003e\n\n  \u003ch3\u003eAPI Keys: Best Practices\u003c/h3\u003e\n  \u003cp\u003eAPI keys are an integral part of secure application development, serving as a means to authenticate and authorize requests to an API. However, if not managed properly, they can pose serious security risks. Here are some best practices for handling API keys:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003eRestrict IP Addresses\u003c/strong\u003e: Make use of the ability to restrict the IP addresses from which the API key can be used. This adds an extra layer of security by ensuring that even if an API key is compromised, it can't be used from an unauthorized location.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eRotate API Keys Periodically\u003c/strong\u003e: Regularly changing your API keys can help prevent unauthorized access if a key is compromised. It is recommended to rotate API keys at least every six months, or whenever significant personnel/system changes occur, or after any known or potential compromises.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eDo Not Store API Keys in Code Repositories\u003c/strong\u003e: API keys should not be stored in files that get checked into your application code repository. Instead, store keys in environmental variables or use secure storage solutions.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eLimit the Scope of an API Key\u003c/strong\u003e: Use different API keys for different applications to limit the scope of each key. This practice not only enhances security but also makes it easier to monitor and manage API usage. For example, you can create up to 50 API keys for your system.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eShare API Keys Securely\u003c/strong\u003e: API keys can be viewed and created by users with admin rights in pixx.io. When sharing keys with non-admins, do so using a medium that is secure, has appropriate access restrictions, and is destroyed after key sharing. This ensures that the keys are only accessible to authorized individuals and are not left exposed where they could potentially be accessed by unauthorized users.\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cp\u003eBy following these best practices, you can significantly enhance the security of your API keys and protect your system from unauthorized access or data breaches.\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eError Handling\u003c/summary\u003e\n\n  \u003ch2\u003eError Handling\u003c/h2\u003e\n  \u003cp\u003eWhen something goes wrong, our API responds with an error message structured like this:\u003c/p\u003e\n  \u003cpre\u003e\u003ccode\u003e{\n  \"success\": false,\n  \"errorGroup\": \"unknown\",\n  \"errorCode\": 2354,\n  \"errorMessage\": \"The required parameter accessToken is missing.\"\n}\u003c/code\u003e\u003c/pre\u003e\n\n  \u003cp\u003eThis error message is made up of:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003esuccess:\u003c/strong\u003e Tells you whether your request was successful (in this case, it's not).\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eerrorGroup:\u003c/strong\u003e Categorizes the error, helping us understand what went wrong.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eerrorCode:\u003c/strong\u003e A unique code assigned to the specific error (primarily for internal use).\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eerrorMessage:\u003c/strong\u003e A description of the error in a language you can understand.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cblockquote\u003e\u003cstrong\u003e⚠️ Note:\u003c/strong\u003e While \u003ccode\u003eerrorCode\u003c/code\u003e is provided, it is primarily intended for internal purposes. You should focus on the returned HTTP Status Code and the \u003ccode\u003eerrorMessage\u003c/code\u003e to understand and address the error.\u003c/blockquote\u003e\n\n  \u003ch3\u003ePossible HTTP Status Codes:\u003c/h3\u003e\n  \u003ctable\u003e\n    \u003cthead\u003e\n      \u003ctr\u003e\n        \u003cth\u003eSituation\u003c/th\u003e\n        \u003cth\u003eHTTP Status Code\u003c/th\u003e\n        \u003cth\u003eWhat It Means\u003c/th\u003e\n      \u003c/tr\u003e\n    \u003c/thead\u003e\n    \u003ctbody\u003e\n      \u003ctr\u003e\u003ctd\u003eSuccessful Request\u003c/td\u003e\u003ctd\u003e200\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eSuccess:\u003c/strong\u003e Your request worked perfectly.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eCreated\u003c/td\u003e\u003ctd\u003e201\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eSuccess:\u003c/strong\u003e Your request has been successfully processed and a new resource has been created.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eNo Content\u003c/td\u003e\u003ctd\u003e204\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eSuccess:\u003c/strong\u003e Your request was successful, but there is no content to return in the response body.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eMalformed Request\u003c/td\u003e\u003ctd\u003e400\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e Your request is a bit off or contains wrong information.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eAuthentication Issue\u003c/td\u003e\u003ctd\u003e401\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e Your request needs proper authentication or the given credentials aren't right.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eAccess Denied\u003c/td\u003e\u003ctd\u003e403\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e The request is valid, but you're not allowed to do that.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eResource Not Found\u003c/td\u003e\u003ctd\u003e404\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e We couldn't find what you're looking for.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eUnsupported Action\u003c/td\u003e\u003ctd\u003e405\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e Your request uses a method that's not supported for this particular resource.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eData Conflict\u003c/td\u003e\u003ctd\u003e409\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e There's a clash, usually because the data already exists.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eToo Many Requests (Rate Limit)\u003c/td\u003e\u003ctd\u003e429\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e Your request is a bit too frequent. Check the Rate Limit guide in this documentation.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eInternal Server Issue\u003c/td\u003e\u003ctd\u003e500\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e Something's not right on our end. If you keep running into this error, contact support.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eFunctionality Not Ready\u003c/td\u003e\u003ctd\u003e501\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e We haven't gotten around to implementing that just yet.\u003c/td\u003e\u003c/tr\u003e\n      \u003ctr\u003e\u003ctd\u003eTemporary Unavailability\u003c/td\u003e\u003ctd\u003e503\u003c/td\u003e\u003ctd\u003e\u003cstrong\u003eError:\u003c/strong\u003e We're taking a short break for maintenance or because things got busy.\u003c/td\u003e\u003c/tr\u003e\n    \u003c/tbody\u003e\n  \u003c/table\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eRate Limits\u003c/summary\u003e\n\n  \u003ch2\u003eRate Limits\u003c/h2\u003e\n  \u003cp\u003eWe've put two different types of rate limits in place to keep things fair and running smoothly.\u003cbr\u003eRate Limits are shared between all API Keys of your system.\u003c/p\u003e\n  \u003col\u003e\n    \u003cli\u003e\u003cstrong\u003e10 Seconds Rate Limit:\u003c/strong\u003e Up to 167 requests per system within a 10-second window. This window starts when the first request is sent and resets to 0 after 10 seconds.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003ePer Day Rate Limit:\u003c/strong\u003e Up to 50,000 requests per system within a single day. This window resets at midnight each day.\u003c/li\u003e\n  \u003c/ol\u003e\n  \u003cp\u003eThese rate limits are designed to ensure that no one user or application takes up more than their fair share of resources.\u003c/p\u003e\n  \u003cp\u003e\n    Make sure to respect the rate limits when you run into them and implement appropriate constraints into your application.\n    If we notice any persistent and extensive disregard for these rate limits we reserve the right to take appropriate actions to ensure fair access for all users, which may include temporary suspension of API access privileges.\u003cbr\u003e\n    If you run into problems with these rate limits feel free to contact the pixx.io support.\n  \u003c/p\u003e\n  \u003cbr\u003e\n  \u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e Please be aware that the specified rate limits are subject to change. We may adjust these limits as needed to optimize system performance and ensure fair resource allocation.\u003c/p\u003e\n\n  \u003ch3\u003eRate Limit HTTP Headers\u003c/h3\u003e\n  \u003cp\u003eEach API response includes the following three headers which can be used to determine the current state for the rate limit:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003eX-RateLimit-Limit:\u003c/strong\u003e This tells you the total number of requests allowed in the upcoming 10 seconds.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eX-RateLimit-Remaining:\u003c/strong\u003e You'll find out how many requests you can still make within the current 10-second window.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eX-RateLimit-Reset:\u003c/strong\u003e This lets you know when the rate limit counter will reset, so you can make more requests.\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cp\u003e\n    It is recommended to listen to these HTTP response headers in your code and adjust the speed of requests being sent accordingly to ensure your program does not run into rate limitations.\n    If you run into one of the rate limits, all further requests will be answered by our API with a HTTP Status Code of 429 'Too Many Requests' until the rate limit windows reset.\n  \u003c/p\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eAsynchronous Jobs\u003c/summary\u003e\n\n  \u003ch2\u003eAsynchronous Jobs\u003c/h2\u003e\n\n  \u003cp\u003eSome of our available API Endpoints trigger actions that can take a bit longer to process, so our API cannot respond with the result right away.\u003cbr\u003e\n  These requests are stored in a MessageQueue and are worked on asynchronously in the background.\n  The following available endpoints make use of this mechanism:\n  \u003c/p\u003e\n\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#file/filesPost\"\u003eFilesPost\u003c/a\u003e:\u003c/strong\u003e Uploading and processing large files.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#file/filesPut\"\u003eFilesPut\u003c/a\u003e:\u003c/strong\u003e Updating files that require server-side processing.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#file/filesDelete\"\u003eFilesDelete\u003c/a\u003e:\u003c/strong\u003e Deleting files that may need additional server actions.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#keyword/keywordsUploadCSV\"\u003eKeywordsUploadCSV\u003c/a\u003e:\u003c/strong\u003e Uploading and processing keyword data from CSV files.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#synonym/synonymsUploadCSV\"\u003eSynonymsUploadCSV\u003c/a\u003e:\u003c/strong\u003e Uploading and processing synonym data from CSV files.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cp\u003eAsynchronous requests are used in scenarios where the server needs more time to handle the request or when the operation may be resource-intensive.\u003c/p\u003e\n\n  \u003cp\u003eWhen you send one of these asynchronous requests, you receive a unique \u003cstrong\u003ejobID\u003c/strong\u003e that represents the job in the message queue. You can use this ID to track the job's progress:\u003c/p\u003e\n\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#job/jobGet\"\u003eJobGet\u003c/a\u003e Request:\u003c/strong\u003e Retrieve detailed information about a specific job using the \u003ccode\u003eJobGet\u003c/code\u003e request. It is common to check the job at intervals to get information about the job's success or if an error occurred during processing.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cpre\u003ecurl --location --globoff \\\n  '{your_mediaspace_url}/api/v1/jobs/{your_job_id}' \\\n  --header 'Authorization: Bearer {{your_api_key}}'\u003c/pre\u003e\n\n  \u003cp\u003eThis request will provide you with insights into the job's current status, progress, and other relevant details.\u003c/p\u003e\n\n  \u003ch3\u003eAborting a Job:\u003c/h3\u003e\n\n  \u003cp\u003eIf you need to stop an ongoing asynchronous job, you can abort it:\u003c/p\u003e\n\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003e\u003ca href=\"#job/jobAbort\"\u003eJobAbort\u003c/a\u003e Request:\u003c/strong\u003e Terminate a specific job.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cpre\u003ecurl --location --globoff --request PUT \\\n  '{your_mediaspace_url}/api/v1/jobs/{your_job_id}' \\\n  --header 'Authorization: Bearer {{your_api_key}}'\u003c/pre\u003e\n\n  \u003cp\u003eThis action will stop the job's execution and prevent further progress.\u003c/p\u003e\n\n  \u003ch3\u003eJob Status and Responses:\u003c/h3\u003e\n\n  \u003cp\u003eAPI responses related to job management provide useful information:\u003c/p\u003e\n\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003ejobType:\u003c/strong\u003e The type of the job being performed.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eisStarted:\u003c/strong\u003e Indicates if the job has started its execution.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eisFinished:\u003c/strong\u003e Indicates if the job has completed its execution.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eprogress:\u003c/strong\u003e Shows the current progress of the job (usually as a percentage).\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003esuccess:\u003c/strong\u003e Indicates whether the job was successful or not.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eerror:\u003c/strong\u003e Provides information about any errors encountered during the job.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003ejobData:\u003c/strong\u003e Additional data related to the job's context and parameters.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cp\u003eThese responses help you monitor the job's status and results. Take a look at the JobGet Endpoint in this documentation to get further information on how the jobData object exactly looks like for each different endpoint.\u003c/p\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eMetadata Fields\u003c/summary\u003e\n\n  \u003ch2\u003eMetadata Fields\u003c/h2\u003e\n  \u003ch3\u003eStandard Metadata Examples\u003c/h3\u003e\n  \u003cp\u003eStandard metadata fields provide commonly used information associated with digital assets. Some standard metadata examples include:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003eTitle:\u003c/strong\u003e The name or title of the asset.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eDescription:\u003c/strong\u003e A brief description or summary of the asset's content.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eCreator:\u003c/strong\u003e The creator or author of the asset.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eKeywords:\u003c/strong\u003e Keywords or tags that help categorize and search for the asset.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eDate Created:\u003c/strong\u003e The date when the asset was created or captured.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eCopyright Information:\u003c/strong\u003e Details about copyright ownership and usage rights.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003cp\u003eFurthermore, pixx.io offers support for various metadata field standards, including common standards such as \u003cstrong\u003eEXIF\u003c/strong\u003e and \u003cstrong\u003eIPTC\u003c/strong\u003e.\u003c/p\u003e\n\n  \u003ch3\u003eCustom Metadata Support\u003c/h3\u003e\n  \u003cp\u003eIn addition to standard metadata, pixx.io also offers support for custom metadata fields. Custom metadata fields allow users to define and associate specific information that is unique to their organization or workflow.\u003c/p\u003e\n\n  \u003cblockquote\u003e\u003cstrong\u003eNote:\u003c/strong\u003e We are aware that the current way of handling Metadata Fields can be a bit confusing and needs further improvements in the future. We are actively working on improving the experience of working with metadata fields within our software and the API.\u003c/blockquote\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eResponse Fields and Attribute Filtering\u003c/summary\u003e\n\n  \u003ch2\u003eResponse Fields and Attribute Filtering\u003c/h2\u003e\n\n  \u003cp\u003eMost of the API's GET endpoints make use of a parameter called \u003ccode\u003eresponseFields\u003c/code\u003e, which allows you to specify which attributes of a resource you want to receive in the response. This is particularly valuable when dealing with complex resources that contain a multitude of attributes.\u003c/p\u003e\n\n  \u003ch3\u003eExample:\u003c/h3\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  '{your_mediaspace_url}/api/v1/files/{{your_file_id}}?responseFields=[\"id\",\"fileName\"]' \\\n  --header 'Authorization: Bearer {{your_api_key}}'\u003c/pre\u003e\n\n  \u003cp\u003eThe expected response of this request is:\u003c/p\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"file\": {\n    \"id\": {file_id},\n    \"fileName\": \"{file_name}\"\n  }\n}\u003c/pre\u003e\n\n  \u003ch3\u003eWhy Response Fields Matter\u003c/h3\u003e\n  \u003cp\u003eUtilizing response fields as a parameter is advantageous for:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003eOptimizing bandwidth by receiving only necessary data.\u003c/li\u003e\n    \u003cli\u003eImproving response time by reducing payload size.\u003c/li\u003e\n    \u003cli\u003eEnhancing security by limiting the exposure of sensitive attributes.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003ch3\u003eObject-Specific Response Fields\u003c/h3\u003e\n  \u003cp\u003eIn addition to general response fields, the API offers object-specific response fields. For example, you might encounter \"userResponseFields\" when interacting with user-related resources. These object-specific fields allow you to further refine the attributes you receive in the response, narrowing down the data to only what's relevant to the specific object type you're working with.\u003c/p\u003e\n\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/files/{file_id}?responseFields=[\"id\",\"fileName\",\"user\"]\u0026userResponseFields=[\"id\",\"userName\"]' \\\n  --header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n\n  \u003cp\u003eThe expected response of this request is:\u003c/p\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"file\": {\n    \"id\": {file_id},\n    \"fileName\": \"{file_name}\",\n    \"user\": {\n      \"id\": {user_id},\n      \"userName\": \"{user_name}\"\n    }\n  }\n}\u003c/pre\u003e\n\n  \u003cbr\u003e\n  \u003cp\u003eCheck the documentation for a specific endpoint to see exactly which response fields are valid for the request.\u003c/p\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003ePagination and Sorting\u003c/summary\u003e\n\n  \u003ch2\u003ePagination and Sorting\u003c/h2\u003e\n\n  \u003ch3\u003ePagination:\u003c/h3\u003e\n  \u003cp\u003ePagination divides large sets of data into smaller chunks.\u003c/p\u003e\n\n  \u003cp\u003eWhen making API requests, you'll work with these two main pagination parameters:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003epage:\u003c/strong\u003e Specify the page number of the data you want.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003epageSize:\u003c/strong\u003e Determine how many items per page you'd like to receive.\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cp\u003eThese parameters allow you to control the quantity of data per response. Check the documentation of the specific endpoints to see the maximum allowed pageSize for this requests.\u003c/p\u003e\n\n  \u003ch3\u003eSorting Data:\u003c/h3\u003e\n  \u003cp\u003eAPI responses can often be sorted based on certain attributes for better organization.\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003esortBy:\u003c/strong\u003e Indicate the attribute by which you want to sort the data (e.g., name, createDate, etc.). Check the documentation of the specific endpoints to see all available sorting options.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003esortDirection:\u003c/strong\u003e Specify the sorting direction, either ascending or descending.\u003c/li\u003e\n  \u003c/ul\u003e\n  \u003cp\u003eThese parameters help you arrange the retrieved data in a meaningful order.\u003c/p\u003e\n\n  \u003ch3\u003eCombining Pagination and Sorting:\u003c/h3\u003e\n  \u003cp\u003eYou can use pagination and sorting together to finely tailor your API requests:\u003c/p\u003e\n  \u003cpre\u003ecurl --location \\\n  '{your_mediaspace_url}/api/v1/files?pageSize=20\u0026sortBy=uploadDate\u0026page=4\u0026sortDirection=ascending' \\\n  --header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n  \u003cp\u003eIn this example, you're requesting the second page of data, each page containing 20 items, sorted by the \"uploadDate\" attribute in ascending order.\u003c/p\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eFilters and Searching\u003c/summary\u003e\n\n  \u003ch2\u003eFilters and Searching\u003c/h2\u003e\n  \u003cp\u003eThe \u003ccode\u003eFilesGet\u003c/code\u003e request allows you to retrieve files based on various filter criteria. This functionality is essential for efficiently searching and accessing specific files within your pixx.io system.\u003c/p\u003e\n\n  \u003ch3\u003eAvailable Filters\u003c/h3\u003e\n  \u003cp\u003eYou can apply one or more of the following filters to narrow down your search results:\u003c/p\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ccode\u003ecollection\u003c/code\u003e: Filter files by their assigned collection.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003ecolorspace\u003c/code\u003e: Search for files based on their color space like RGB or CMYK.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003econnectorAnd\u003c/code\u003e and \u003ccode\u003econnectorOr\u003c/code\u003e: Apply logical AND or OR operators to combine multiple filters to create complex search queries.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003ecreateDate\u003c/code\u003e: Filter files based on the date they were created.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003ecreator\u003c/code\u003e: Search for files created by a specific user or creator.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003edescription\u003c/code\u003e: Find files using descriptions or keywords associated with them.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003edirectory\u003c/code\u003e: Filter files based on their directory or folder location.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003efileExtension\u003c/code\u003e: Search for files with specific file extensions.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003efileName\u003c/code\u003e: Search for files by their names.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003efileState\u003c/code\u003e: Filter files based on their current state or status.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003efileType\u003c/code\u003e: Search for files based on their file type (e.g., image, video).\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003eheight\u003c/code\u003e: Filter files by their height dimension.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003ewidth\u003c/code\u003e: Filter files by their width dimension.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003ekeyword\u003c/code\u003e: Search for files using keywords associated with them.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003eisSubversion\u003c/code\u003e: Filter subversion files.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003elocation\u003c/code\u003e: Search for files based on their geographical location.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003emetadataFieldDate\u003c/code\u003e: Filtering the metadata of files which have the edit type \"date\".\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003emetadataFieldLocation\u003c/code\u003e: Filtering the metadata of files which have the edit type \"location\".\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003emetadataFieldSelection\u003c/code\u003e: Filtering the metadata of files which have the edit type \"selection\".\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003emetadataFieldText\u003c/code\u003e: filtering the metadata of files.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003emodifyDate\u003c/code\u003e: Filter files based on the date they were last modified.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003euploadDate\u003c/code\u003e: Filter files based on the date they were uploaded.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003eorientation\u003c/code\u003e: Search for files based on their orientation (e.g., landscape, portrait).\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003erating\u003c/code\u003e: Find files with specific user ratings.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003esubject\u003c/code\u003e: Search for files by subject or topic.\u003c/li\u003e\n    \u003cli\u003e\u003ccode\u003euser\u003c/code\u003e: Filter files based on the user.\u003c/li\u003e\n  \u003c/ul\u003e\n\n  \u003ch3\u003eExamples\u003c/h3\u003e\n  \u003cp\u003eHere is an example of how to use the FilesGet request with a connectorAnd Filter. In this example the filter searches for files which have \"cat\" AND \"miau\" in their description:\u003c/p\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/files?page=1\u0026pageSize=4\u0026sortBy=uploadDate\u0026filter={\n    \"filterType\": \"connectorAnd\",\n    \"filters\": [\n      {\n        \"filterType\": \"description\",\n        \"term\": \"cat\",\n        \"exactMatch\": false,\n        \"useSynonyms\": true,\n        \"inverted\": false\n      },\n      {\n        \"filterType\": \"description\",\n        \"term\": \"miau\",\n        \"exactMatch\": false,\n        \"useSynonyms\": true,\n        \"inverted\": false\n      }\n    ],\n    \"inverted\": false\n  }' \\\n  --header 'Authorization: Bearer {your_api_key}'\n  \u003c/pre\u003e\n\n  \u003cp\u003eHere is an example of how to use the FilesGet request with a connectorOr Filter. In this example the filter searches for files which have \"portrait\" OR \"widescreen\" as orientation:\u003c/p\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/files?page=1\u0026pageSize=10\u0026sortBy=fileName\u0026filter={\n    \"filterType\": \"connectorOr\",\n    \"filters\": [\n      {\n        \"filterType\": \"orientation\",\n        \"orientation\": \"portrait\",\n        \"inverted\": false\n      },\n      {\n        \"filterType\": \"orientation\",\n        \"orientation\": \"widescreen\",\n        \"inverted\": false\n      }\n    ],\n    \"inverted\": false\n  }' \\\n  --header 'Authorization: Bearer {your_api_key}'\n  \u003c/pre\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eRequest Examples\u003c/summary\u003e\n\n  \u003ch2\u003eRequest Examples\u003c/h2\u003e\n\n  \u003ch3\u003eFile Upload\u003c/h3\u003e\n  \u003ch4\u003eUpload Your File - \u003ca href=\"#file/filesPost\"\u003eFilesPost\u003c/a\u003e\u003c/h4\u003e\n  \u003cp\u003eUpload a file to the server using the FilesPost endpoint. Includes file details like the description and keywords such as the option to upload asynchronously.\u003c/p\u003e\n  \u003cpre\u003ecurl --location 'https://{your_mediaspace_url}/api/v1/files' \\\n  --header 'Authorization: Bearer {your_api_key}' \\\n  --form 'file={your_file}' \\\n  --form 'description=\"This is the best juice in the world\"' \\\n  --form 'keywords=[\"apple\",\"orange\"]' \\\n  --form 'asynchronousConversion=\"true\"'\u003c/pre\u003e\n\n  \u003ch4\u003eExpected Response:\u003c/h4\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"jobID\": {job_id}\n}\u003c/pre\u003e\n\n  \u003ch4\u003eTrack Progress - \u003ca href=\"#job/jobGet\"\u003eJobGet\u003c/a\u003e\u003c/h4\u003e\n  \u003cp\u003eTrack a specific job to get more information about it. Common use is to send jobGet Requests in intervals until the job is finished.\u003c/p\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/jobs/{your_job_id}' \\\n  --header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n\n  \u003cp\u003eIf you want to learn more about asynchronous jobs, please refer to the \u003ca href=\"#general Information/Asynchronous Jobs\"\u003eAsynchronous Jobs\u003c/a\u003e section.\u003c/p\u003e\n\n  \u003cbr\u003e\u003cbr\u003e\n\n  \u003ch3\u003eRetrieve File Information\u003c/h3\u003e\n  \u003ch4\u003eRetrieve File Information - \u003ca href=\"#file/fileGet\"\u003eFileGet\u003c/a\u003e\u003c/h4\u003e\n  \u003cp\u003eRetrieve detailed information about a specific file using the FileGet endpoint. Specify \u003ca href=\"#general Information/Response Fields\"\u003eresponse Fields\u003c/a\u003e to customize the output. In this case id and fileName should be returned in the response.\u003c/p\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/files/{file_id}?responseFields=[\"id\",\"fileName\"]' \\\n  --header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n\n  \u003ch4\u003eExpected Response\u003c/h4\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"file\": {\n    \"id\": {file_id},\n    \"fileName\": \"{file_name}\"\n  }\n}\u003c/pre\u003e\n\n  \u003cbr\u003e\u003cbr\u003e\n\n  \u003ch3\u003eCreate a Collection\u003c/h3\u003e\n  \u003ch4\u003eCreate a Collection - \u003ca href=\"#collection/collectionsPost\"\u003eCollectionsPost\u003c/a\u003e\u003c/h4\u003e\n  \u003cp\u003eCreate a new collection with a specific name, description, and a list of file IDs which should be included in the collection.\u003c/p\u003e\n  \u003cpre\u003ecurl --location 'https://{your_mediaspace_url}/api/v1/collections' \\\n  --header 'Authorization: Bearer {your_api_key}' \\\n  --header 'Content-Type: application/json' \\\n  --data-raw '{\n      \"name\": \"Beautiful Pictures\",\n      \"description\": \"The most beautiful places in Bavaria.\",\n      \"fileIDs\": [1, 2, 3, 4, 5]\n  }'\u003c/pre\u003e\n\n  \u003ch4\u003eExpected Response\u003c/h4\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"id\": {collection_id}\n}\u003c/pre\u003e\n\n  \u003cbr\u003e\u003cbr\u003e\n\n  \u003ch3\u003eRetrieve Collection Information\u003c/h3\u003e\n  \u003ch4\u003eRetrieve Collection Information - \u003ca href=\"#collection/collectionGet\"\u003eCollectionGet\u003c/a\u003e\u003c/h4\u003e\n  \u003cp\u003eRetrieve information about a specific collection. In this case it includes its name, modification date, and information about the user who created it like the id and the username.\u003c/p\u003e\n  \u003cpre\u003ecurl --location --globoff \\\n  'https://{your_mediaspace_url}/api/v1/collections/{collection_id}?userResponseFields=[\"id\",\"userName\"]\u0026responseFields=[\"id\",\"name\",\"modifyDate\"]' \\\n  --header 'Authorization: Bearer {your_api_key}'\u003c/pre\u003e\n\n  \u003ch4\u003eExpected Response:\u003c/h4\u003e\n  \u003cpre\u003e{\n  \"success\": true,\n  \"collection\": {\n    \"id\": {collection_id},\n    \"name\": \"{collection_name}\",\n    \"modifyDate\": \"{collection_modifyDate}\",\n    \"user\": {\n      \"id\": {user_id},\n      \"userName\": \"{user_Name}\"\n    }\n  }\n}\u003c/pre\u003e\n\n\u003c/details\u003e\n\n",
"title": "pixx.io API",
"version": "v1"
},
"openapi": "3.0.0",
"paths": {
"/api/v1/collections": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003ecollectionDelete\u003c/code\u003e endpoint removes one or more collections from your pixx.io workspace. Collections group assets logically and deleting them only removes the association, not the actual files.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to clean up or reorganize your collections without affecting the underlying assets.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eFiles remain in the system; only their grouping is removed.\u003c/li\u003e \u003cli\u003eEnsure the user has appropriate permissions to delete controller_collections. \u003c/li\u003e \u003c/ul\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "CollectionsDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6563313461"
}
},
{
"in": "query",
"name": "async",
"schema": {
"description": "\u003cp\u003eOptional. Makes the request asynchronous when set to true. The response will contain a jobID. It is HIGHLY RECOMMENDED to set this parameter to true to avoid timeouts.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"invalidIDs": {
"$ref": "#/components/schemas/ArrayOfCollectionDeleteObject"
},
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CollectionsDelete",
"tags": [
"Collections"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003ecollectionsGet\u003c/code\u003e endpoint retrieves a list of collections within the pixx.io system. Collections are used to organize files either statically or dynamically and can be filtered, sorted, and paginated.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is useful for rendering collection overviews or managing collections in administrative interfaces.\u003c/p\u003e\n\u003ch3\u003ePerformance Note\u003c/h3\u003e\n\u003cp\u003eUse \u003ccode\u003eresponseFields\u003c/code\u003e to limit the data returned and improve performance.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "CollectionsGet",
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"description": "Page number to retrieve.",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"description": "Maximum number of results per page.",
"example": 4,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "collectionIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3532303039"
}
},
{
"in": "query",
"name": "isDynamic",
"schema": {
"description": "Filters by whether the collection is dynamic (true) or static (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "portalID",
"schema": {
"description": "Filters for collections created within a specific portal context.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "spaceID",
"schema": {
"description": "Filters for collections referenced by a specific space context.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Searches for collections whose name contains this term.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "withFileID",
"schema": {
"description": "Filters collections that contain the specified file ID (only valid when isDynamic = false).",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "withoutFileID",
"schema": {
"description": "Filters collections that do NOT contain the specified file ID (only valid when isDynamic = false).",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"description": "If true, collections include sub-version files.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3739306633"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "Sorts the result set by the specified field.",
"enum": [
"createDate",
"modifyDate",
"name",
"order"
],
"example": "name",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "desc",
"description": "Sorts the result in ascending or descending order.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "userIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6364623939"
}
},
{
"in": "query",
"name": "hasInddFile",
"schema": {
"description": "Filters the collections that contain Adobe InDesign files.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "The language for the response (e.g., 'de', 'en').",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivates translation fallback. If no translation exists, the response will not fall back to default.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3965376634"
}
},
{
"in": "query",
"name": "sharedUsersResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3836653062"
}
},
{
"in": "query",
"name": "sharedPermissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3265383563"
}
},
{
"in": "query",
"name": "assetNavigatorResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6664396236"
}
},
{
"in": "query",
"name": "previewFilesLimit",
"schema": {
"default": 4,
"description": "Limit the number of preview files returned per collection.",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "previewFilesFilter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "previewFilesPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6263303830"
}
},
{
"in": "query",
"name": "previewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3365313263"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"collections": {
"items": {
"$ref": "#/components/schemas/Collection"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CollectionsGet",
"tags": [
"Collections"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003ecollectionsPost\u003c/code\u003e endpoint creates a new collection in pixx.io. Collections group related files either statically (by file list) or dynamically (via filters).\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to organize assets for internal workflows, campaigns, or client-facing portals.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eFor static collections, the \u003ccode\u003ename\u003c/code\u003e and \u003ccode\u003efileIDs\u003c/code\u003e are required.\u003c/li\u003e \u003cli\u003eFor dynamic collections, specify \u003ccode\u003efilterID\u003c/code\u003e; \u003ccode\u003ename\u003c/code\u003e is optional and defaults to the filter's name.\u003c/li\u003e \u003cli\u003eCollections can be shared with specific users or permission groups.\u003c/li\u003e \u003cli\u003eSet \u003ccode\u003einternalShareGlobally\u003c/code\u003e to allow access for all internal users. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "CollectionPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"assetNavigatorID": {
"description": "Optional. Associates the collection with an asset navigator.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"async": {
"description": "Create collection asynchronously.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"description": {
"description": "Optional description for the collection.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"fileIDs": {
"$ref": "#/components/schemas/ArrayOfID_3335616530"
},
"filterID": {
"description": "The ID of the filter to define a dynamic collection.\u003cbr\u003erequired if: isDynamic == true",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"internalShareGlobally": {
"description": "Specifies if the collection should be shared internally with all users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"internalShareMessage": {
"description": "Optional message shown to users when sharing internally.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"isDynamic": {
"default": false,
"description": "Specifies whether the collection is dynamic (true) or static (false).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"name": {
"description": "The name of the collection.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"sharedPermissionGroupIDs": {
"$ref": "#/components/schemas/ArrayOfID_3236646338"
},
"sharedUserIDs": {
"$ref": "#/components/schemas/ArrayOfID_3433373233"
},
"subscribeCollection": {
"description": "Specifies if the user should subscribe to the collection after creation.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateDescription": {
"description": "Explicitly unset the collection description.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"jobID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CollectionPost",
"tags": [
"Collections"
]
}
},
"/api/v1/collections/{collection_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003ecollectionGet\u003c/code\u003e endpoint retrieves detailed information about a single collection. Collections are used to organize files, and this endpoint returns metadata and configuration settings.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is typically used in administrative or display contexts where you want to view how a collection is structured, what files it contains, or how it's shared.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "CollectionGet",
"parameters": [
{
"in": "path",
"name": "collection_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3565656437"
}
},
{
"in": "query",
"name": "assetNavigatorResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3430666563"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Disables fallback to default language when no translation exists.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "Language of the response (e.g., 'de', 'en').",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "previewFilesFilter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "previewFilesLimit",
"schema": {
"default": 4,
"description": "Maximum number of preview files to return.",
"example": 4,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "previewFilesPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6662303363"
}
},
{
"in": "query",
"name": "previewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6161373435"
}
},
{
"in": "query",
"name": "sharedPermissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3263373839"
}
},
{
"in": "query",
"name": "sharedUsersResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3165333963"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"default": false,
"description": "Whether to include both mainVersions and subVersions in the file response.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3163666365"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"collection": {
"$ref": "#/components/schemas/Collection"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CollectionGet",
"tags": [
"Collections"
]
},
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003ecollectionPut\u003c/code\u003e endpoint allows you to update existing collections of files within pixx.io, enabling you to manage and modify collection details as needed.\u003c/p\u003e\n\n\u003cp\u003e\u003ch2\u003eEndpoint Details\u003c/h2\u003e \u003cp\u003e\u003cstrong\u003eEndpoint:\u003c/strong\u003e \u003ccode\u003ePUT /collections/{collection_id}\u003c/code\u003e\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eAuthentication:\u003c/strong\u003e Requires a valid API key.\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eParameters:\u003c/strong\u003e Replace \u003ccode\u003e{collection_id}\u003c/code\u003e with the specific ID of the collection you want to update.\u003c/p\u003e\u003c/p\u003e\n\u003cp\u003e\u003ch2\u003eRequest Body\u003c/h2\u003e \u003cp\u003eThe request body should include the updated information for the collection. (see below)\u003c/p\u003e\u003c/p\u003e\n\u003cp\u003e\u003ch2\u003eResponse\u003c/h2\u003e \u003cp\u003eUpon successful update, the endpoint responds with a status code \u003ccode\u003e200 OK\u003c/code\u003e.\u003c/p\u003e\u003c/p\u003e\n\u003cp\u003e\u003ch2\u003eImportant Considerations\u003c/h2\u003e \u003cp\u003eUpdating a collection allows you to modify its details without affecting the associated files. Ensure you have the appropriate permissions and understand the impact before using this endpoint.\u003c/p\u003e\u003c/p\u003e\n\u003cp\u003e\u003ch2\u003eRequest Structure\u003c/h2\u003e \u003cp\u003eHere's how the request is structured:\u003c/p\u003e\u003c/p\u003e ",
"operationId": "CollectionPut",
"parameters": [
{
"in": "path",
"name": "collection_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"addInternalSharedPermissionGroupIDs": {
"$ref": "#/components/schemas/ArrayOfID_3864393635"
},
"addInternalSharedUserIDs": {
"$ref": "#/components/schemas/ArrayOfID_3261323666"
},
"assetNavigatorID": {
"description": "Sets the asset navigator ID the collection should belong to.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"async": {
"description": "\u003cp\u003eOptional. Makes the request asynchronous when set to true. The response will contain a jobID. It is HIGHLY RECOMMENDED to set this parameter to true to avoid timeouts.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"description": {
"description": "Updates the description of the collection.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"fileIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_3536323937"
},
"fileIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3938643731"
},
"internalShareGlobally": {
"description": "Sets whether the collection is shared internally with all users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"internalShareMessage": {
"description": "Sets an optional message displayed to users receiving internal sharing.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"name": {
"description": "Updates the name of the collection.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"previewFileIDs": {
"$ref": "#/components/schemas/ArrayOfID_3933333436"
},
"removeInternalSharedPermissionGroupIDs": {
"$ref": "#/components/schemas/ArrayOfID_3734326635"
},
"removeInternalSharedUserIDs": {
"$ref": "#/components/schemas/ArrayOfID_3362313931"
},
"truncateAssetNavigatorID": {
"description": "Unset the assetNavigatorID (sets it to undefined).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateDescription": {
"description": "Unset the description (sets it to undefined).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"userID": {
"description": "Specifies a user ID that should become the new owner of the collection.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CollectionPut",
"tags": [
"Collections"
]
}
},
"/api/v1/directLinks": {
"delete": {
"description": "\u003cp\u003eThe directLinksDelete endpoint allows you to remove existing direct links to files within pixx.io.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful deletion, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint enables you to remove direct links without affecting the underlying files. Ensure you have the necessary permissions to delete direct links.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectLinksDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectLinksDelete",
"tags": [
"Direct Links"
]
},
"get": {
"description": "\u003cp\u003eThe directLinksGet endpoint empowers you to effortlessly fetch direct links to specific files within pixx.io. These direct links offer seamless access for sharing or embedding files.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested direct links.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eBy employing this endpoint, you acquire direct links to files without altering the files themselves. Make certain that you possess the necessary permissions to access direct links.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e pagination is used here. If you want to learn more about Pagination, please refer to the 'General Information' section.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectLinksGet",
"parameters": [
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3463653737"
}
},
{
"in": "query",
"name": "fileResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3666356263"
}
},
{
"in": "query",
"name": "downloadFormatResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
},
{
"in": "query",
"name": "fileIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
},
{
"in": "query",
"name": "fileName",
"schema": {
"description": "Filters the directLinks by the specified name (Wildcard Search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "isCustom",
"schema": {
"description": "Filters the directLinks for only custom (not original or preview) directLinks.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "fileName",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"fileName",
"fileSize",
"id",
"modifyDate"
],
"example": "createDate",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directLinks": {
"items": {
"$ref": "#/components/schemas/DirectLink"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectLinksGet",
"tags": [
"Direct Links"
]
},
"post": {
"description": "\u003cp\u003eThe directLinksPost endpoint empowers you to create direct links to specific files within pixx.io. These direct links simplify sharing and embedding files for convenient access.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details to create a direct link.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful creation, the endpoint responds with a status code 200 OK and provides information about the newly created direct link.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eBy utilizing this endpoint, you can seamlessly generate direct links to files without altering the files themselves. Ensure you possess the appropriate permissions to create direct links.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the structure of the request:\u003c/p\u003e ",
"operationId": "DirectLinkPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_6637356239"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: maxSize, minSize, height, width"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directLinkID": {
"description": "\u003cp\u003e\u003cstrong\u003eThe ID of the created directLink.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"downloadURL": {
"description": "\u003cp\u003e\u003cstrong\u003eThe URL to the converted FileBasic.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e, \u003ccode\u003eresponseType: path\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: directLink\u003c/code\u003e: The directLink.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: path\u003c/code\u003e: This URL is valid for 24 hours.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"fileExtension": {
"description": "\u003cp\u003e\u003cstrong\u003eThe fileExtension\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "jpg",
"title": "FileExtension",
"type": "string"
},
"fileName": {
"description": "\u003cp\u003e\u003cstrong\u003eThe fileName\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the job which creates the directLink",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectLinkPost",
"tags": [
"Direct Links"
]
}
},
"/api/v1/directLinks/{id}": {
"get": {
"description": "\u003cp\u003eThe directLinkGet endpoint allows you to retrieve a directLink to a specific file within pixx.io. These direct links provide easy access to files for sharing or embedding.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides information about a specific directLink.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to get a directLinks to a file without affecting the file itself. Ensure you have the right permissions to access directLinks.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectLinkGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3463653737"
}
},
{
"in": "query",
"name": "fileResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3666356263"
}
},
{
"in": "query",
"name": "downloadFormatResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directLink": {
"$ref": "#/components/schemas/DirectLink"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectLinkGet",
"tags": [
"Direct Links"
]
}
},
"/api/v1/directories": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003edirectoriesGet\u003c/code\u003e endpoint allows you to retrieve information about multiple directories within pixx.io. Directories provide an organized structure for managing your files efficiently.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful for fetching metadata about directories, such as their id, name, parent, and file counts.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectoriesGet",
"parameters": [
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the directories by the specified name (wildcard search).",
"example": "Items",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 1,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 20,
"minimum": 1,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "permission",
"schema": {
"description": "This permission filter can be used to only include directories in the response where you have a specific permission for the files inside the directory.",
"enum": [
"modifyFiles",
"modify",
"showFiles",
"uploadFiles"
],
"example": "modifyFiles",
"title": "PermissionDirectory",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3966356536"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"default": false,
"description": "Whether to include subVersions in the calculation of the file quantity for each directory.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "filesFilter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "parentID",
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directories": {
"items": {
"$ref": "#/components/schemas/Directory"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoriesGet",
"tags": [
"Directories"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003edirectoriesPost\u003c/code\u003e endpoint allows you to create a new directory within pixx.io. Directories provide an organized structure for efficiently managing your files.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eControl characters are not allowed in the \u003ccode\u003ename\u003c/code\u003e of the directory. These include: \u003ccode\u003e / : * ? \u0026quot; \u0026lt; \u0026gt; |\u003c/code\u003e\u003c/li\u003e \u003cli\u003eMultiple spaces in directory names will be combined into one.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "DirectoryPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3533333531"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoryPost",
"tags": [
"Directories"
]
}
},
"/api/v1/directories/tree": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003edirectoriesTree\u003c/code\u003e endpoint allows you to retrieve a hierarchical tree structure of directories within pixx.io. This structure includes parent and child relationships, offering a comprehensive view of your directory organization.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to understand the organizational structure of your directories, especially when visualizing or traversing hierarchical relationships.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eEither \u003ccode\u003eparentID\u003c/code\u003e or \u003ccode\u003echildID\u003c/code\u003e can be set, but not both.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: childID, parentID",
"operationId": "DirectoriesTree",
"parameters": [
{
"in": "query",
"name": "childID",
"schema": {
"description": "Used to fetch the parents and siblings of a specified directory ID.\u003cbr\u003e\u003cp\u003eImagine the following Directories: \u003ccode\u003e/one/two/three/four\u003c/code\u003e \u003ccode\u003e/one/two/three/five\u003c/code\u003e \u003ccode\u003e/six\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eFor \u003ccode\u003echildID = 4\u003c/code\u003e you receive the following response: \u003ccode\u003eparents: [1,2,3]\u003c/code\u003e \u003ccode\u003echildren: [4,5]\u003c/code\u003e\u003c/p\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "parentID",
"schema": {
"description": "Used to fetch the children and hierarchy below a specified parent directory ID.\u003cbr\u003e\u003cp\u003eImagine the following Directories: \u003ccode\u003e/one/two/three/four\u003c/code\u003e \u003ccode\u003e/one/two/three/five\u003c/code\u003e \u003ccode\u003e/six\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eWithout Specifying the parentID and the childID you receive the following response: \u003ccode\u003eparents: []\u003c/code\u003e \u003ccode\u003echildren: [1,6]\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eFor \u003ccode\u003eparentID = 3\u003c/code\u003e you receive the following response: \u003ccode\u003eparents: [1,2,3]\u003c/code\u003e \u003ccode\u003echildren: [4,5]\u003c/code\u003e\u003c/p\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3337313835"
}
},
{
"in": "query",
"name": "permission",
"schema": {
"description": "This permission filter can be used to only include directories in the response where you have a specific permission for the files inside the directory.\u003cbr\u003e\u003cp\u003eThe permission filter for the received directories. Note: Applying this filter with the value \u0026quot;uploadFiles\u0026quot; for example, does not imply that all returned directories have \u0026quot;uploadFiles = true\u0026quot; in its permissions-Object in the response. This is because the parents of the directories where the user has the permission to upload are also returned, so that the client connecting to the API can show the complete directory tree for its purpose.\u003c/p\u003e\n\u003cp\u003eImagine the following Directories: \u003ccode\u003e/one/two/three/four\u003c/code\u003e \u003ccode\u003e/one/two/three/five\u003c/code\u003e \u003ccode\u003e/six\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eImagine the user only has the permission to upload in directory 4 and the filter \u0026quot;permission = uploadFiles\u0026quot; is applied.\u003c/p\u003e\n\u003cp\u003eWithout Specifying the parentID and the childID you receive the following response: \u003ccode\u003eparents: []\u003c/code\u003e \u003ccode\u003echildren: [1]\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eFor \u003ccode\u003eparentID = 3\u003c/code\u003e you receive the following response: \u003ccode\u003eparents: [1,2,3]\u003c/code\u003e \u003ccode\u003echildren: [4]\u003c/code\u003e\u003c/p\u003e ",
"enum": [
"modifyFiles",
"modify",
"showFiles",
"uploadFiles"
],
"example": "modifyFiles",
"title": "PermissionDirectory",
"type": "string"
}
},
{
"in": "query",
"name": "showChildren",
"schema": {
"default": true,
"description": "Include the children field in the response. Improves performance when disabled.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "showParents",
"schema": {
"default": false,
"description": "Include the parents field in the response. Improves performance when disabled.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"default": false,
"description": "Consider subVersions in quantity calculations.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "filesFilter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "userCurrentlyInSettings",
"schema": {
"default": false,
"description": "Indicates if a user is currently in the settingsSection where he can see every directory (only valid for users with right \\\"editUsers\\\").",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"children": {
"$ref": "#/components/schemas/ArraySchema_6664303565"
},
"parents": {
"$ref": "#/components/schemas/ArraySchema_6233373335"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoriesTree",
"tags": [
"Directories"
]
}
},
"/api/v1/directories/{directory_id}": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003edirectoryDelete\u003c/code\u003e endpoint allows you to remove existing directories within your pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to clean up unused or outdated directory structures while retaining associated files.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eDirectories can only be deleted if they are empty.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectoryDelete",
"parameters": [
{
"in": "path",
"name": "directory_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoryDelete",
"tags": [
"Directories"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003edirectoryGet\u003c/code\u003e endpoint enables you to retrieve detailed metadata about a specific directory in your pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful for integrations needing to display or manage folders in a tree-like view or for permission auditing.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DirectoryGet",
"parameters": [
{
"in": "path",
"name": "directory_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6639616330"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"default": false,
"description": "Whether to include subVersions in the calculation of the file quantity for the directory.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "filesFilter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directory": {
"$ref": "#/components/schemas/Directory"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoryGet",
"tags": [
"Directories"
]
},
"put": {
"description": "\u003cp\u003eThe directoryPut endpoint enables you to update existing directories within pixx.io. Directories provide a structured way to organize and manage your files efficiently.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful for updating the name or the parent of an existing directory, supporting better content organization or restructuring.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eEnsure that directories with the same name do not exist under the same parent, otherwise this request will fail.\u003c/li\u003e \u003cli\u003eStick to alphanumeric characters and avoid special characters in directory names (except for spaces, underscores and dashes).\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "DirectoryPut",
"parameters": [
{
"in": "path",
"name": "directory_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"name": {
"description": "The new name for the directory. Must be unique within the same parent.\u003cbr\u003eInvalid characters: \\/:*?\"\u003c\u003e|",
"example": "My DirectoryBasic",
"title": "DirectoryName",
"type": "string"
},
"parentID": {
"description": "The ID of the new directory's parent.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.\u003cbr\u003e**Only if:** a new parent ID is specified",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DirectoryPut",
"tags": [
"Directories"
]
}
},
"/api/v1/downloadFormats": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003edownloadFormatsGet\u003c/code\u003e endpoint retrieves a list of all download formats currently configured in your pixx.io system. A download format defines how files can be transformed before download (e.g., resize, format conversion).\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is typically used to audit available formats for UI rendering or administrative review, or before assigning formats to specific assets.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eEach returned format includes its name, settings, and display-related metadata.\u003c/li\u003e \u003cli\u003eThe output can be used for read-only or prefill use cases when editing. \u003c/li\u003e \u003c/ul\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DownloadFormatsGet",
"parameters": [
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6635393666"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "Language of the response (e.g., 'de', 'en').",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the downloadFormats by the specified name (wildcard search).",
"example": "Example",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6132636239"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "userCurrentlyInSettings",
"schema": {
"default": false,
"description": "The flag indicates if a user is currently in the settings section where all formats are visible.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivates the translation fallback.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"downloadFormats": {
"items": {
"$ref": "#/components/schemas/DownloadFormat"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DownloadFormatsGet",
"tags": [
"Download Formats"
]
}
},
"/api/v1/downloadFormats/{downloadFormat_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003edownloadFormatGet\u003c/code\u003e endpoint retrieves detailed information about a specific download format in pixx.io. Download formats define how files are processed and delivered (e.g., resizing, file type conversion).\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to inspect the transformation rules and configurations associated with a given download format.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "DownloadFormatGet",
"parameters": [
{
"in": "path",
"name": "downloadFormat_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "The language of the response. Defaults to the system language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6132636239"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"description": "If true, disables fallback to system language when no translation is available for the selected language.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"downloadFormat": {
"$ref": "#/components/schemas/DownloadFormat"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "DownloadFormatGet",
"tags": [
"Download Formats"
]
}
},
"/api/v1/externalShares": {
"delete": {
"description": "This is the Delete-Endpoint of externalShares.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ExternalSharesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ExternalSharesDelete",
"tags": [
"External Shares"
]
},
"get": {
"description": "This is the BatchGetEndpoint of externalShares.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ExternalSharesGet",
"parameters": [
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3963393231"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3563333235"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
},
{
"in": "query",
"name": "collectionResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3962646563"
}
},
{
"in": "query",
"name": "collectionPreviewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3666356263"
}
},
{
"in": "query",
"name": "collectionPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6338326632"
}
},
{
"in": "query",
"name": "collectionPreviewFilesLimit",
"schema": {
"default": 4,
"description": "The maximum number of preview files returned in a share",
"example": 2,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the external-shares by the specified name (Wildcard Search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "nameExactMatch",
"schema": {
"description": "Filters the external-shares by the specified name (exact match).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "isActive",
"schema": {
"description": "isActive = false: external-share is expired",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "hasCollection",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "collectionIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "createDate",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"externalShares": {
"items": {
"$ref": "#/components/schemas/ExternalShare"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ExternalSharesGet",
"tags": [
"External Shares"
]
},
"post": {
"description": "This is the Post-postEndpoint of externalShares.",
"operationId": "ExternalSharePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 1 can have a value: collectionID, fileIDs\u003cbr\u003eout of the following fields only 0 or 1 can have a value: password, encryptedPassword"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The ID of the created external-share.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ExternalSharePost",
"tags": [
"External Shares"
]
}
},
"/api/v1/externalShares/{id}": {
"get": {
"description": "This is the Get-Endpoint of an externalShare.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ExternalShareGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3631626365"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3563333235"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
},
{
"in": "query",
"name": "collectionResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3962646563"
}
},
{
"in": "query",
"name": "collectionPreviewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3666356263"
}
},
{
"in": "query",
"name": "collectionPreviewFilesLimit",
"schema": {
"default": 4,
"description": "The maximum number of preview files returned in a collection",
"example": 2,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "collectionPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6338326632"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"externalShare": {
"$ref": "#/components/schemas/ExternalShare"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ExternalShareGet",
"tags": [
"External Shares"
]
},
"put": {
"description": "This is the Put-Endpoint of an externalShare. You can edit already created externalShares.",
"operationId": "ExternalSharePut",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"allowComments": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"allowDownloads": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"allowUpvotes": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"description": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"downloadFormatIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
},
"downloadFormatIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
},
"emailsToAdd": {
"$ref": "#/components/schemas/ArrayOfEmailLanguage_6262333231"
},
"fileDetailsToAdd": {
"$ref": "#/components/schemas/ArrayOfFileDetail"
},
"fileDetailsToRemove": {
"$ref": "#/components/schemas/ArrayOfFileDetail"
},
"fileIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_3232333834"
},
"fileIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3831353462"
},
"forceDownloadProof": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"forceWatermark": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatFree": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatOriginal": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"hasDownloadFormatPreview": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"isDisabled": {
"description": "manually disable the share",
"example": true,
"title": "Bool",
"type": "boolean"
},
"mediaViewsToAdd": {
"$ref": "#/components/schemas/ArrayOfMediaViewType"
},
"mediaViewsToRemove": {
"$ref": "#/components/schemas/ArrayOfMediaViewType"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"description": "the text in the email notification of share recipients",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"password": {
"description": "A password.",
"example": "censored",
"title": "Password",
"type": "string"
},
"termsOfUse": {
"description": "displayed when the user downloads files from the share",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"truncateDescription": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateNotificationText": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncatePassword": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateTermsOfUse": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"validityPeriod": {
"description": "The validity period of the external share.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ExternalSharePut",
"tags": [
"External Shares"
]
}
},
"/api/v1/fileStates": {
"get": {
"description": "\u003cp\u003eThe fileStatesGet endpoint allows you to retrieve existing file states in pixx.io. A file state is a specific state that a file can have, such as \u0026quot;in progress\u0026quot;, \u0026quot;completed\u0026quot;, or \u0026quot;archived\u0026quot;.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested file states.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "FileStatesGet",
"parameters": [
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "The elements in the fileStates attribute of the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "order",
"description": "The elements in the fileStates attribute of the response are sorted by this parameter.",
"enum": [
"color",
"createDate",
"id",
"modifyDate",
"name",
"order"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6234343463"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the fileStates by the specified name (wildcard search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "userCurrentlyInSettings",
"schema": {
"default": false,
"description": "The flag indicates if a user is currently in the settingsSection where he can see every fileState. (only valid for users with right \\\"editUsers\\\")",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "permissionAssignFiles",
"schema": {
"description": "Filters the fileStates for the ones which the user is allowed to assign to files.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "permissionShowFiles",
"schema": {
"description": "Filters the fileStates for the ones where the user is allowed to see files with.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isArchive",
"schema": {
"description": "Filters the fileStates for the ones configured as an archive fileState.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"fileStates": {
"$ref": "#/components/schemas/ArraySchema_3033653264"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FileStatesGet",
"tags": [
"File States"
]
}
},
"/api/v1/fileStates/{file_state_id}": {
"get": {
"description": "\u003cp\u003eThe fileStatesGet endpoint allows you to retrieve a specific file state in pixx.io A file state is status information about a file, such as whether it is archived or not.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested file state.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "FileStateGet",
"parameters": [
{
"in": "path",
"name": "file_state_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6234343463"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"fileState": {
"$ref": "#/components/schemas/FileState"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FileStateGet",
"tags": [
"File States"
]
}
},
"/api/v1/files": {
"delete": {
"description": "\u003cp\u003eThe filesDelete endpoint allows you to remove existing files within pixx.io. This action effectively deletes files from your workspace.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint permanently removes files from your workspace. Ensure you have the necessary permissions and exercise caution when using this endpoint. Here's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 1 can have a value: filter, iDs",
"operationId": "FilesDelete",
"parameters": [
{
"in": "query",
"name": "filter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "showSubversions",
"schema": {
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e has parameter filter\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003etrue\u003c/strong\u003e contains main- and sub-versions\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003efalse\u003c/strong\u003e contains only main-versions\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3565343634"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FilesDelete",
"tags": [
"Files"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003efilesGet\u003c/code\u003e endpoint enables you to retrieve information about multiple files within pixx.io. This information includes metadata, download links, and other attributes associated with each file.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code \u003ccode\u003e200 OK\u003c/code\u003e and provides information about the requested files, including their metadata, download links, and other attributes.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to access file details without affecting the files themselves. Ensure you have the necessary permissions to retrieve file information. \u003cstrong\u003eNote:\u003c/strong\u003e pagination is used here. If you want to learn more about Pagination, please refer to the 'General Information' section.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: semanticQuery, semanticReferenceHash, semanticFileID\u003cbr\u003eout of the following fields only 0 or 1 can have a value: page, pageCursor",
"operationId": "FilesGet",
"parameters": [
{
"in": "query",
"name": "showFiles",
"schema": {
"default": true,
"description": "\u003cp\u003eA flag if the files attribute should appear in the response.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only enable this flag when necessary.\u003c/p\u003e\n\u003cp\u003eDisabling the files attribute significantly reduces the workload on the server, which also leads to increased performance.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "approximateQuantity",
"schema": {
"default": false,
"description": "\u003cp\u003eThis flag allows approximation of file quantity instead of forcing an exact count in the response.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please enable this flag when you don't need an exact count.\u003c/p\u003e\n\u003cp\u003eEnabling this attribute reduces the workload on the server, which also leads to increased performance.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "page",
"schema": {
"deprecated": true,
"description": "\u003cp\u003eOffset-based pagination is being phased out and will be removed in a future release. New integrations should use \u003cstrong\u003ecursor-based pagination\u003c/strong\u003e with \u003ccode\u003epageCursor\u003c/code\u003e. \u003cstrong\u003eOnly if\u003c/strong\u003e showFile: true;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageCursor",
"schema": {
"description": "a string term\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e showFile: true; Cursor-based pagination token. Omit or set to \u003ccode\u003enull\u003c/code\u003e for the first page, then pass the \u003ccode\u003ecursor\u003c/code\u003e value from the previous response to retrieve the next page.\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"description": "The maximum number of entries returned in a single response.\u003cbr\u003e**Only if** showFile: true\u003cbr\u003erequired if: showFiles == true",
"example": 4,
"maximum": 500,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the response. The default language is the system language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "previewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6338326632"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6339313436"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6235343563"
}
},
{
"in": "query",
"name": "directoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6431323934"
}
},
{
"in": "query",
"name": "fileStateResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3037623030"
}
},
{
"in": "query",
"name": "variantStackResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6438613433"
}
},
{
"in": "query",
"name": "staticCollectionsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6538396137"
}
},
{
"in": "query",
"name": "licenseReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6166623062"
}
},
{
"in": "query",
"name": "modelReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6435376236"
}
},
{
"in": "query",
"name": "propertyReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3936613265"
}
},
{
"in": "query",
"name": "licensesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6338653162"
}
},
{
"in": "query",
"name": "modelsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6632303534"
}
},
{
"in": "query",
"name": "propertiesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3139633563"
}
},
{
"in": "query",
"name": "importantMetadataResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3066363732"
}
},
{
"in": "query",
"name": "filter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "filterMarkedFiles",
"schema": {
"default": false,
"description": "\u003cp\u003eFilters for the marked files of the user.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eAttention\u003c/strong\u003e: If this parameter is specified, files which are not part of the markedFiles of the user are not included in the response.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "showSubVersions",
"schema": {
"default": false,
"description": "\u003cp\u003e\u003ccode\u003etrue:\u003c/code\u003e The files response contains mainVersions and subVersions \u003ccode\u003efalse:\u003c/code\u003e The files response only contains mainVersions\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "includeSubVersions",
"schema": {
"default": false,
"description": "\u003cp\u003etrue: The files response contains mainVersions and subVersions false: The files response only contains mainVersions\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "includeArchived",
"schema": {
"default": false,
"description": "\u003cp\u003etrue: The files response contains archived files false: The files response only contains non-archived files\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "uploadDate",
"description": "The elements in the response are sorted by this parameter.\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003eshowfile: true\u003c/code\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eWarning:\u003c/strong\u003e The sort parameters \u003ccode\u003eexternalShareNumberOfComments\u003c/code\u003e, \u003ccode\u003eexternalShareNumberOfDownloads\u003c/code\u003e, \u003ccode\u003eexternalShareNumberOfUpvotes\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eare only applicable if the current user is an externalShareUser. They are ignored if the current user is a regular pixxio user.\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"colorspace",
"createDate",
"creator",
"externalShareNumberOfComments",
"externalShareNumberOfDownloads",
"externalShareNumberOfUpvotes",
"fileName",
"fileState",
"height",
"id",
"isArchived",
"isDownloadLocked",
"languageCodes",
"modifyDate",
"orientation",
"pixel",
"rating",
"uploadDate",
"width"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.\u003cbr\u003e**Only if** showfile: true",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortByExternalShareSortByUpvotes",
"schema": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortByExternalShareSortByComments",
"schema": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortByExternalShareSortByDownloads",
"schema": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "externalShareID",
"schema": {
"description": "\u003cp\u003eThe ID of the externalShare in the context of which the image is looked at. Only if this parameter is specified, the responseFields \u003ccode\u003eexternalShareNumberOfComment\u003c/code\u003e, \u003ccode\u003eexternalShareNumberOfUpvotes\u003c/code\u003e, and \u003ccode\u003eexternalShareNumberOfDownloads\u003c/code\u003e return non-nil values.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eAttention\u003c/strong\u003e: If this parameter is specified, files which are not part of the specified externalShare are not included in the response.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "uploadLinkID",
"schema": {
"description": "\u003cp\u003eThe ID of the uploadLink in the context of which the image is looked at. Only if this parameter is specified, the responseFields \u003ccode\u003euploadLinkGuestUserName\u003c/code\u003e and \u003ccode\u003euploadLinkGuestUserEmail\u003c/code\u003e return non-nil values.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eAttention\u003c/strong\u003e: If this parameter is specified, files which are not part of the specified uploadLink are not included in the response.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "variantStackID",
"schema": {
"description": "\u003cp\u003eThe ID of the variantStack in the context of which the image is looked at. Only if this parameter is specified, the responseFields \u003ccode\u003evariantStackLinkName\u003c/code\u003e return non-nil values.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eAttention\u003c/strong\u003e: If this parameter is specified, files which are not part of the specified variantStack are not included in the response.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "showAnalysis",
"schema": {
"default": false,
"description": "\u003cp\u003eA flag if the analysis attribute should appear in the response.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eIn terms of fair use of the API:\u003c/strong\u003e please only enable this flag when necessary.\u003c/p\u003e\n\u003cp\u003eDisabling the analysis attribute significantly reduces the workload on the server,\u003c/p\u003e\n\u003cp\u003ewhich also leads to increased performance.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "analysis",
"schema": {
"$ref": "#/components/schemas/FilesAnalysis"
}
},
{
"in": "query",
"name": "semanticQuery",
"schema": {
"description": "The semanticQuery.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
{
"in": "query",
"name": "semanticReferenceHash",
"schema": {
"description": "The semanticFileReferenceHash is used as the reference asset hash to sort the files result by visual similarity to this asset.",
"example": "abc12334frf",
"title": "Token",
"type": "string"
}
},
{
"in": "query",
"name": "semanticFileID",
"schema": {
"description": "The semanticFileID is used as the reference fileID to sort the files result by visual similarity to this file.",
"example": 1234567890,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"analysis": {
"$ref": "#/components/schemas/FilesAnalysis_3833636164"
},
"cursor": {
"description": "\u003cp\u003e\u003cstrong\u003eNot exist when:\u003c/strong\u003e page != null; Cursor for fetching the next page of results. Present \u003cstrong\u003eonly when\u003c/strong\u003e cursor-based pagination is used (\u003ccode\u003epage == null\u003c/code\u003e). Pass this value as \u003ccode\u003epageCursor\u003c/code\u003e in the next request to retrieve the following page. If this field is absent, the last page has been reached.\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"files": {
"$ref": "#/components/schemas/ArraySchema_6335623334"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.\u003cbr\u003e**Not exist when:** showFiles: false",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"quantityType": {
"description": "\u003cp\u003e\u003ccode\u003eeq:\u003c/code\u003e The true quantity is equal to the response quantity \u003ccode\u003egte:\u003c/code\u003e The true quantity is greater or equal to the response quantity\u003c/p\u003e \u003cbr\u003e**Not exist when:** showFiles: false",
"enum": [
"eq",
"gte"
],
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FilesGet",
"tags": [
"Files"
]
},
"post": {
"description": "\u003cp\u003eThe filesPost endpoint allows you to upload new files to pixx.io. This enables you to add new assets to your workspace for management and organization.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful upload, the endpoint responds with a status code 200 OK and provides information about the newly uploaded file or about the jobID of the asynchronous job. If you want to learn more about MessageQueueJobs, please refer to the 'General Information' section.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to add new files to your workspace for management. Ensure you have the necessary permissions and adhere to file upload guidelines. It is crucial to set the Content-Type header to multipart/form-data when making your requests. This header informs the server that you are uploading files using the multipart/form-data format, which is commonly used for file uploads. Failing to set this header correctly may result in unexpected behavior. Here's how the request is structured:\u003c/p\u003e ",
"operationId": "FilePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3931383238"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: replaceID, versionID"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"duplicateFileID": {
"description": "If the uploaded file was a duplicate, this is the ID of the duplicate file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"id": {
"description": "\u003cp\u003eThe ID of the uploaded file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if:\u003c/strong\u003e asynchronousConversion = false\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"isDuplicate": {
"description": "\u003cp\u003eIf the uploaded file was a duplicate.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if:\u003c/strong\u003e asynchronousConversion = false\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.\u003cbr\u003e**Only if:** asynchronousConversion = true",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"storageUsage": {
"description": "\u003e **Only if:** asynchronousConversion = false",
"example": 50,
"maximum": 100,
"minimum": 0,
"title": "Percent",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FilePost",
"tags": [
"Files"
]
},
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003efilesPut\u003c/code\u003e endpoint allows you to update existing files within the pixx.io Digital Asset Management (DAM) system. This enables you to modify file-related attributes and metadata.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the updated file attributes and metadata. This typically involves modifying attributes such as filename, description, or other associated metadata.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful update, the endpoint responds with a status code \u003ccode\u003e200 OK\u003c/code\u003e and provides the jobID of the asynchronous job. If you want to learn more about MessageQueueJobs, please refer to the 'General Information' section.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to modify existing files and their associated attributes. Ensure you have the necessary permissions and adhere to file update guidelines. Here's how the request is structured:\u003c/p\u003e ",
"operationId": "FilesPut",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"appendDescription": {
"description": "Append the description of the file.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"createDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"creator": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"description": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"directoryID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"downloadLocked": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"fileName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"fileNameWithExtension": {
"description": "FileName is an Entity for a FileName. Control Characters at the beginning and end of the name are removed. Control Characters inside the FileBasic Name are replaced by one whitespace.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileStateChangeComment": {
"description": "\u003cp\u003eThe comment which is created when the fileState is changed.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Only considered, when the fileState is changed\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Required when the changed fileStateID is a fileState where comments are forced\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"fileStateID": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filter": {
"$ref": "#/components/schemas/FilesFilter"
},
"ids": {
"$ref": "#/components/schemas/ArrayOfID_6233383138"
},
"keywordsRecognitionToAdd": {
"$ref": "#/components/schemas/ArrayOfTerm_6331393133"
},
"keywordsRecognitionToRemove": {
"$ref": "#/components/schemas/ArrayOfTerm_6533376634"
},
"keywordsToAdd": {
"$ref": "#/components/schemas/ArrayOfTerm_6464643138"
},
"keywordsToRemove": {
"$ref": "#/components/schemas/ArrayOfTerm_6239323666"
},
"languageCodesToAdd": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"languageCodesToRemove": {
"$ref": "#/components/schemas/ArrayOfLanguageCode"
},
"licenseReleasesToAdd": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject"
},
"licenseReleasesToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6139656565"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"metadataAppendText": {
"$ref": "#/components/schemas/MapOfArrayOfString"
},
"metadataCustom": {
"$ref": "#/components/schemas/ArrayOfMetadataObject_6339393264"
},
"metadataDate": {
"$ref": "#/components/schemas/MapOfDateTime_3561643630"
},
"metadataFocalPoint": {
"$ref": "#/components/schemas/MapOfFocalPoint_6634373839"
},
"metadataLanguageToAdd": {
"$ref": "#/components/schemas/MapOfArrayOfLanguageCode_6363386466"
},
"metadataLanguageToRemove": {
"$ref": "#/components/schemas/MapOfArrayOfLanguageCode_3835393633"
},
"metadataLocation": {
"$ref": "#/components/schemas/MapOfLocation"
},
"metadataMultiSelectionToAdd": {
"$ref": "#/components/schemas/MapOfArrayOfTerm"
},
"metadataMultiSelectionToRemove": {
"$ref": "#/components/schemas/MapOfArrayOfTerm_3332373064"
},
"metadataSelection": {
"$ref": "#/components/schemas/MapOfTerm"
},
"metadataStandard": {
"$ref": "#/components/schemas/ArrayOfMetadataObject_3636663566"
},
"metadataText": {
"$ref": "#/components/schemas/MapOfString"
},
"modelReleasesToAdd": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject_6133666264"
},
"modelReleasesToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3339353163"
},
"propertyReleasesToAdd": {
"$ref": "#/components/schemas/ArrayOfLicenseFileObject_3831353263"
},
"propertyReleasesToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3838393663"
},
"rating": {
"description": "The rating of the file.",
"example": 4,
"maximum": 5,
"minimum": 1,
"title": "Rating",
"type": "integer"
},
"rotate90DegreesClockwise": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"rotate90DegreesCounterClockwise": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showSubVersions": {
"default": false,
"description": "\u003cp\u003e\u003ccode\u003etrue:\u003c/code\u003e The files response contains mainVersions and subVersions \u003ccode\u003efalse:\u003c/code\u003e The files response only contains mainVersions\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"subject": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"truncateCreateDate": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateCreator": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateDescription": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateFileState": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateLocation": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateMetadataFields": {
"$ref": "#/components/schemas/ArrayOfTerm_3464383832"
},
"truncateRating": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateSubject": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadDate": {
"description": "A date and datetime in the format of YYYY-MM-DD HH:MM:SS",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"userID": {
"description": "The new owner of the file.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 1 can have a value: filter, iDs"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.\u003cbr\u003e**Only if:** more than 1 file is updated",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FilesPut",
"tags": [
"Files"
]
}
},
"/api/v1/files/convert": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003efilesDownload\u003c/code\u003e endpoint allows you to initiate a download request for converting files from pixx.io. This enables you to get files in the required formats for your workflow.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint initiates a download request for converting files into desired formats. Ensure you have the necessary permissions and adhere to the conversion guidelines.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: maxSize, minSize, height, width\u003cbr\u003eout of the following fields only 1 can have a value: filter, iDs",
"operationId": "FilesDownload",
"parameters": [
{
"in": "query",
"name": "filter",
"schema": {
"$ref": "#/components/schemas/FilesFilter"
}
},
{
"in": "query",
"name": "showSubversions",
"schema": {
"description": "\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e has parameter filter\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003etrue\u003c/strong\u003e contains main- and sub-versions\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003efalse\u003c/strong\u003e contains only main-versions\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6638343235"
}
},
{
"in": "query",
"name": "fileName",
"schema": {
"description": "The file's name.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "zipName",
"schema": {
"description": "\u003cp\u003eWhen multiple files are converted, a zip file is created containing all the converted files. Determines the fileName of the Zip-File.\u003c/p\u003e ",
"example": "file.jpg",
"title": "FileName",
"type": "string"
}
},
{
"in": "query",
"name": "forceZip",
"schema": {
"default": false,
"description": "\u003cp\u003eWhen multiple files are converted, a zip file is created containing all the converted files. This Flag forces the zipping also for single file conversions.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "applyMetadata",
"schema": {
"default": false,
"description": "\u003cp\u003e\u003cstrong\u003etrue:\u003c/strong\u003e The metadata in pixx.io is applied to the file, including the filename. \u003cstrong\u003efalse:\u003c/strong\u003e The metadata in pixx.io is not applied to the file. For the \u003ccode\u003edownloadType: original\u003c/code\u003e the original file is downloaded without any modification.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "stripMetadata",
"schema": {
"default": false,
"description": "If true, all the metadata is stripped from the file, which can drastically reduce the fileSize.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "downloadType",
"schema": {
"default": "original",
"description": "\u003cp\u003e\u003cstrong\u003eoriginal:\u003c/strong\u003e Download the original file without conversion. \u003cstrong\u003epreview:\u003c/strong\u003e Download the preview file without conversion. \u003cstrong\u003ecustom:\u003c/strong\u003e Converts the original file with the specified settings. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original files with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original file with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes.\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"custom",
"downloadFormat",
"original",
"preview"
],
"example": "original",
"title": "DownloadType",
"type": "string"
}
},
{
"in": "query",
"name": "downloadFormatID",
"schema": {
"description": "\u003cp\u003eThe ID of the download format.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eRequired if\u003c/strong\u003e \u003ccode\u003edownloadType: downloadFormat\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003erequired if: downloadType == \"downloadFormat\"",
"example": 83,
"title": "Int",
"type": "integer"
}
},
{
"in": "query",
"name": "fileExtension",
"schema": {
"default": "jpg",
"description": "\u003cp\u003eThe output file extension of the converted file for the downloadType custom.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"jpg",
"pdf",
"png",
"tiff",
"webp"
],
"example": "jpg",
"title": "DownloadDestinationFormat",
"type": "string"
}
},
{
"in": "query",
"name": "layers",
"schema": {
"$ref": "#/components/schemas/ArrayOfInt"
}
},
{
"in": "query",
"name": "addWatermark",
"schema": {
"default": false,
"description": "\u003cp\u003eApply the configured Watermark and the configured WatermarkText to the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "colorspace",
"schema": {
"default": "RGB",
"description": "\u003cp\u003eThis parameter determines the colorspace of the output file. The colorspace CMYK is invalid for the fileExtension png.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND NOT (\u003ccode\u003efileExtension: png\u003c/code\u003e AND \u003ccode\u003ecolorspace: CMYK\u003c/code\u003e)\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
}
},
{
"in": "query",
"name": "quality",
"schema": {
"default": 90,
"description": "\u003cp\u003eDetermines the quality of the output file in terms of JPG Quantization. This parameter only affects the output file for the fileExtension jpg.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND \u003ccode\u003efileExtension: jpg or webp\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
}
},
{
"in": "query",
"name": "density",
"schema": {
"default": 72,
"description": "\u003cp\u003eDetermines the density of the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
}
},
{
"in": "query",
"name": "crop",
"schema": {
"$ref": "#/components/schemas/CropSector"
}
},
{
"in": "query",
"name": "rotation",
"schema": {
"default": 0,
"description": "\u003cp\u003eRotate the output file with this parameter.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"title": "Rotation",
"type": "integer"
}
},
{
"in": "query",
"name": "allowUpscaling",
"schema": {
"default": false,
"description": "\u003cp\u003eImagine an BatchConvertInput Image with the resolution 1000x1000 Pixel and the determined parameter width of 2000 Pixel. \u003cstrong\u003etrue:\u003c/strong\u003e The resolution of the output image is 2000x2000 Pixel due to Upscaling. \u003cstrong\u003efalse:\u003c/strong\u003e The resolution of the output image is still 1000x1000 Pixel.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "resizeFilter",
"schema": {
"default": "default",
"description": "\u003cp\u003eDetermines the filter used for resizing. This parameter can impact the workload on the server what also leads to increasing performance.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"default",
"lanczos",
"mitchell"
],
"example": "default",
"title": "ResizeFilter",
"type": "string"
}
},
{
"in": "query",
"name": "unit",
"schema": {
"default": "px",
"description": "\u003cp\u003eDetermines the length unit for the parameter width, height, maxSize, and minSize.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
}
},
{
"in": "query",
"name": "maxSize",
"schema": {
"description": "\u003cp\u003eResize the long side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "minSize",
"schema": {
"description": "\u003cp\u003eResize the short side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "height",
"schema": {
"description": "\u003cp\u003eResize the height of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "width",
"schema": {
"description": "\u003cp\u003eResize the width of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "downloadProof",
"schema": {
"description": "The downloadProof.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
{
"in": "query",
"name": "userName",
"schema": {
"description": "\u003cp\u003eThe userName of the ExternalShareGuestUser who downloads the file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCondition:\u003c/strong\u003e Required for ExternalShareGuestUser\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "email",
"schema": {
"description": "The email of the ExternalShareGuestUser who downloads the file.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"omittedFiles": {
"$ref": "#/components/schemas/ArrayOfID_3238393134"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FilesDownload",
"tags": [
"Files"
]
}
},
"/api/v1/files/{id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003efileGet\u003c/code\u003e endpoint allows you to retrieve details of a specific file within pixx.io. This information includes metadata, download links, and other file-related details.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code \u003ccode\u003e200 OK\u003c/code\u003e and provides comprehensive information about the requested file.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to access specific file details without affecting the file itself. Ensure you have the necessary permissions to retrieve file information.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "FileGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "externalShareID",
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "uploadLinkID",
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "previewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_3265383638"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6262333761"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3563333235"
}
},
{
"in": "query",
"name": "directoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3134353537"
}
},
{
"in": "query",
"name": "fileStateResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3335383636"
}
},
{
"in": "query",
"name": "variantStackResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3634336166"
}
},
{
"in": "query",
"name": "staticCollectionsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3962646563"
}
},
{
"in": "query",
"name": "licenseReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6166623062"
}
},
{
"in": "query",
"name": "modelReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6435376236"
}
},
{
"in": "query",
"name": "propertyReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3936613265"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731326163"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesLimit",
"schema": {
"default": 4,
"description": "PositiveInt is a natural number, i.e. a positive integer with a value \u003e 0 (must not be equal to 0).",
"example": 105,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "licensesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6338653162"
}
},
{
"in": "query",
"name": "modelsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6632303534"
}
},
{
"in": "query",
"name": "propertiesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3139633563"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the response. The default language is the system language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"file": {
"$ref": "#/components/schemas/File"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FileGet",
"tags": [
"Files"
]
}
},
"/api/v1/files/{id}/convert": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003efileDownload\u003c/code\u003e endpoint allows you to initiate a download request for converting a specific file into a desired format within pixx.io. This enables you to obtain files in the required formats for your workflow.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details for the download request.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful initiation, the endpoint responds with a status code \u003ccode\u003e200 OK\u003c/code\u003e and provides information about the conversion request.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint initiates a download request for converting files into desired formats. Ensure you have the necessary permissions and adhere to the conversion guidelines.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: maxSize, minSize, height, width",
"operationId": "FileDownload",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "fileName",
"schema": {
"description": "\u003cp\u003eThe fileName of the directLink.\u003cbr\u003e \u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e The fileName of the directLink is unique. Specifying an already existing fileName will result in a permission error.\u003c/p\u003e \u003c/blockquote\u003e \u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Do not specify the fileExtension here. The fileExtension is appended on the server.\u003c/p\u003e \u003c/blockquote\u003e \u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e This will change the fileURL of the directLink. The old fileURL is no longer valid.\u003c/p\u003e \u003c/blockquote\u003e \u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCondition:\u003c/strong\u003e\u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "applyMetadata",
"schema": {
"default": false,
"description": "\u003cp\u003e\u003cstrong\u003etrue:\u003c/strong\u003e The metadata in pixx.io is applied to the file, including the filename. \u003cstrong\u003efalse:\u003c/strong\u003e The metadata in pixx.io is not applied to the file. For the \u003ccode\u003edownloadType: original\u003c/code\u003e the original file is downloaded without any modification.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "stripMetadata",
"schema": {
"default": false,
"description": "If true, all the metadata is stripped from the file, which can drastically reduce the fileSize.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "responseType",
"schema": {
"default": "path",
"description": "\u003cp\u003e\u003cstrong\u003epath:\u003c/strong\u003e The response returns the URL to the converted \u003ccode\u003eFileBasic\u003c/code\u003e. This URL is valid for 24 hours. \u003cstrong\u003edirectLink:\u003c/strong\u003e A new \u003ccode\u003edirectLink\u003c/code\u003e is created. The response returns the URL (\u003ccode\u003edirectLink\u003c/code\u003e) to the converted \u003ccode\u003eFileBasic\u003c/code\u003e. This URL is valid until the \u003ccode\u003edirectLink\u003c/code\u003e or the original file is deleted. The original file size must not exceed 1 GB for images or 5 GB for other file types (applied to DirectLinks of \u003ccode\u003edownloadType = [original, custom, downloadFormat]\u003c/code\u003e) \u003cstrong\u003ebase64:\u003c/strong\u003e The response returns the converted file as base64.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e If this endpoint succeeds, the response does not contain JSON but base64!\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eRequirement:\u003c/strong\u003e The following response header is present for the base64 response: \u003ccode\u003eContent-Type: text/plain; charset=ISO-8859-1\u003c/code\u003e \u003cstrong\u003ebinary:\u003c/strong\u003e The response returns the converted file as binary data.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e If this endpoint succeeds, the response does not contain JSON but binary data!\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eRequirement:\u003c/strong\u003e The following response headers are present for the binary response: \u003ccode\u003eContent-Disposition: attachment; filename=MyFileName.jpg; filename*= UTF-8''MyFileName.jpg\u003c/code\u003e, \u003ccode\u003eContent-Type: application/octet-stream; charset=ISO-8859-1\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"base64",
"binary",
"directlink",
"path"
],
"example": "path",
"title": "DownloadResponseType",
"type": "string"
}
},
{
"in": "query",
"name": "downloadType",
"schema": {
"default": "original",
"description": "\u003cp\u003e\u003cstrong\u003eoriginal:\u003c/strong\u003e Download the original file without conversion. \u003cstrong\u003epreview:\u003c/strong\u003e Download the preview file without conversion. \u003cstrong\u003ecustom:\u003c/strong\u003e Converts the original file with the specified settings. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original files with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes. \u003cstrong\u003edownloadFormat:\u003c/strong\u003e Converts the original file with the settings determined by the specified \u003ccode\u003eDownloadFormatBasic\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Depending on the original file and the conversion settings this request can last a few seconds or even minutes.\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"custom",
"downloadFormat",
"original",
"preview"
],
"example": "original",
"title": "DownloadType",
"type": "string"
}
},
{
"in": "query",
"name": "downloadFormatID",
"schema": {
"description": "\u003cp\u003eThe ID of the download format.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eRequired if\u003c/strong\u003e \u003ccode\u003edownloadType: downloadFormat\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003erequired if: downloadType == \"downloadFormat\"",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "fileExtension",
"schema": {
"default": "jpg",
"description": "\u003cp\u003eThe output file extension of the converted file for the downloadType custom.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"jpg",
"pdf",
"png",
"tiff",
"webp"
],
"example": "jpg",
"title": "DownloadDestinationFormat",
"type": "string"
}
},
{
"in": "query",
"name": "layers",
"schema": {
"$ref": "#/components/schemas/ArrayOfUint"
}
},
{
"in": "query",
"name": "addWatermark",
"schema": {
"default": false,
"description": "\u003cp\u003eApply the configured Watermark and the configured WatermarkText to the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "colorspace",
"schema": {
"default": "RGB",
"description": "\u003cp\u003eThis parameter determines the colorspace of the output file. The colorspace CMYK is invalid for the fileExtension png.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND NOT (\u003ccode\u003efileExtension: png\u003c/code\u003e AND \u003ccode\u003ecolorspace: CMYK\u003c/code\u003e)\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"CMYK",
"GRAY",
"RGB"
],
"example": "RGB",
"title": "ConversionColorspace",
"type": "string"
}
},
{
"in": "query",
"name": "quality",
"schema": {
"default": 90,
"description": "\u003cp\u003eDetermines the quality of the output file in terms of JPG Quantization. This parameter only affects the output file for the fileExtension jpg.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e AND \u003ccode\u003efileExtension: jpg or webp\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"maximum": 100,
"minimum": 0,
"title": "Quality",
"type": "integer"
}
},
{
"in": "query",
"name": "density",
"schema": {
"default": 72,
"description": "\u003cp\u003eDetermines the density of the output file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 300,
"minimum": 1,
"title": "Density",
"type": "integer"
}
},
{
"in": "query",
"name": "crop",
"schema": {
"$ref": "#/components/schemas/CropSector"
}
},
{
"in": "query",
"name": "rotation",
"schema": {
"default": 0,
"description": "\u003cp\u003eRotate the output file with this parameter.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 90,
"title": "Rotation",
"type": "integer"
}
},
{
"in": "query",
"name": "allowUpscaling",
"schema": {
"default": false,
"description": "\u003cp\u003eImagine an ConvertInput Image with the resolution 1000x1000 Pixel and the determined parameter width of 2000 Pixel. \u003cstrong\u003etrue:\u003c/strong\u003e The resolution of the output image is 2000x2000 Pixel due to Upscaling. \u003cstrong\u003efalse:\u003c/strong\u003e The resolution of the output image is still 1000x1000 Pixel.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "resizeFilter",
"schema": {
"default": "default",
"description": "\u003cp\u003eDetermines the filter used for resizing. This parameter can impact the workload on the server what also leads to increasing performance.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"default",
"lanczos",
"mitchell"
],
"example": "default",
"title": "ResizeFilter",
"type": "string"
}
},
{
"in": "query",
"name": "unit",
"schema": {
"default": "px",
"description": "\u003cp\u003eDetermines the length unit for the parameter width, height, maxSize, and minSize.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"enum": [
"cm",
"inch",
"mm",
"px"
],
"example": "mm",
"title": "LengthUnit",
"type": "string"
}
},
{
"in": "query",
"name": "maxSize",
"schema": {
"description": "\u003cp\u003eResize the long side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "minSize",
"schema": {
"description": "\u003cp\u003eResize the short side of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "height",
"schema": {
"description": "\u003cp\u003eResize the height of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "width",
"schema": {
"description": "\u003cp\u003eResize the width of the file to the specified size by keeping the aspect ratio.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: custom\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAt most one of the parameters\u003c/strong\u003e \u003ccode\u003ewidth, height, maxSize, minSize\u003c/code\u003e \u003cstrong\u003eshall be set.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `no resize`",
"example": 93,
"minimum": 0,
"title": "Uint",
"type": "integer"
}
},
{
"in": "query",
"name": "downloadProof",
"schema": {
"description": "The downloadProof.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
{
"in": "query",
"name": "userName",
"schema": {
"description": "\u003cp\u003eThe userName of the ExternalShareGuestUser who downloads the file.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCondition:\u003c/strong\u003e Required for ExternalShareGuestUser\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "email",
"schema": {
"description": "The email of the ExternalShareGuestUser who downloads the file.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
}
},
{
"in": "query",
"name": "skipFileNameSanitization",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "skipCheckForceTransferOriginal",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "useUnicodeCombiningForURL",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "directLinkCreationAsync",
"schema": {
"default": false,
"description": "\u003cp\u003eCreate the directLink asynchronously. The response contains a jobID in that case.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eOnly if\u003c/strong\u003e \u003ccode\u003edownloadType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e \u003cbr\u003edefault: `false`",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"directLinkID": {
"description": "\u003cp\u003e\u003cstrong\u003eThe ID of the created directLink.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"downloadURL": {
"description": "\u003cp\u003e\u003cstrong\u003eThe URL to the converted FileBasic.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e, \u003ccode\u003eresponseType: path\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: directLink\u003c/code\u003e: The directLink.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: path\u003c/code\u003e: This URL is valid for 24 hours.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"fileExtension": {
"description": "\u003cp\u003e\u003cstrong\u003eThe fileExtension\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "jpg",
"title": "FileExtension",
"type": "string"
},
"fileName": {
"description": "\u003cp\u003e\u003cstrong\u003eThe fileName\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
},
"application/octet-stream; charset=ISO-8859-1": {
"schema": {
"format": "binary",
"type": "string"
}
},
"text/plain; charset=ISO-8859-1": {
"schema": {
"format": "base64",
"type": "string"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FileDownload",
"tags": [
"Files"
]
}
},
"/api/v1/files/{id}/mainVersion": {
"put": {
"description": "Update the main-version of a version stack of files.",
"operationId": "FileUpdateMainVersion",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "FileUpdateMainVersion",
"tags": [
"Files"
]
}
},
"/api/v1/jobs/{id}": {
"get": {
"description": "\u003cp\u003eThe jobGet endpoint allows you to retrieve details of a specific job within the pixx.io Message Queue system. This information provides insights into the status and progress of the job, helping you monitor its execution.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides comprehensive information about the requested job, including its status, progress, and other attributes.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to access specific job details within the Message Queue system. Ensure you have the necessary permissions and understand job status meanings. \u003cstrong\u003eNote:\u003c/strong\u003e if you want to learn more about MessageQueueJobs, please refer to the 'General Information' section.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "JobGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3061373665"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"job": {
"$ref": "#/components/schemas/Job"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "JobGet",
"tags": [
"Jobs"
]
},
"put": {
"description": "\u003cp\u003eThe jobAbort endpoint allows you to abort a specific job within the pixx.io Message Queue system. Aborting a job stops its execution and can help manage resources effectively.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful abortion, the endpoint responds with a status code 200 OK and provides information confirming the abortion of the specified job.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint allows you to stop the execution of a specific job within the Message Queue system. Ensure you have the necessary permissions and understand the implications of aborting jobs. \u003cstrong\u003eNote:\u003c/strong\u003e if you want to learn more about MessageQueueJobs, please refer to the 'General Information' section.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "JobAbort",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "JobAbort",
"tags": [
"Jobs"
]
}
},
"/api/v1/keywords": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003ekeywordsDelete\u003c/code\u003e endpoint allows you to remove specific keyword data from the keyword dictionary. The keyword dictionary can be found in the settings of your pixx.io mediaspace.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint when you want to remove certain keywords or clear out all keywords entirely. This can be helpful for correcting tagging mistakes or removing deprecated terms from your keyword dictionary.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eDeleting a keyword from the dictionary with this endpoint does not delete the keyword from the files.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "KeywordsDelete",
"parameters": [
{
"in": "query",
"name": "all",
"schema": {
"description": "To delete all keywords in the dictionary. Use with caution.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6363333462"
}
},
{
"in": "query",
"name": "keywords",
"schema": {
"$ref": "#/components/schemas/ArrayOfTerm_6565653631"
}
},
{
"in": "query",
"name": "ignoreNotExistingKeywords",
"schema": {
"description": "If true, the request will not result in an error if a specified keyword does not exist.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "KeywordsDelete",
"tags": [
"Keywords"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003ekeywordsGet\u003c/code\u003e endpoint allows you to retrieve keyword information from pixx.io. Keywords provide an efficient way to categorize and organize your assets.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is commonly used to load a filtered or paginated list of keywords that are present in your keyword dictionary.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eThis endpoint does not return all the keywords assigned to files, only the keywords present in the keyword dictionary. To retrieve all keywords assigned to files, you have to iterate over all files using the Files Get getEndpoint and collect the keywords from them.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "KeywordsGet",
"parameters": [
{
"in": "query",
"name": "exactMatch",
"schema": {
"description": "Whether the name filter should apply exact match instead of wildcard search.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the keywords by the specified name (Wildcard Search).",
"example": "Example",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "permissionGroupIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3032666630"
}
},
{
"in": "query",
"name": "permissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3265383739"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6534373730"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"keywords": {
"items": {
"$ref": "#/components/schemas/Keyword"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "KeywordsGet",
"tags": [
"Keywords"
]
}
},
"/api/v1/keywords/csv": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003ekeywordsDownloadCSV\u003c/code\u003e endpoint allows you to export all keyword data from your pixx.io media space as a CSV file. The CSV export can be returned as a link, a base64 string or binary data.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful when you want to audit, manage or back up your keywords, or edit them in bulk using spreadsheet software like Excel to reimport them later into pixx.io.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "KeywordsDownloadCSV",
"parameters": [
{
"in": "query",
"name": "csvFieldDelimiter",
"schema": {
"default": ";",
"description": "The CSV Field delimiter which separates the fields in a CSV record.",
"enum": [
"\t",
",",
";"
],
"example": ";",
"title": "CsvFieldDelimiter",
"type": "string"
}
},
{
"in": "query",
"name": "responseType",
"schema": {
"default": "path",
"description": "The response format of the CSV download.\u003cbr\u003e\u003cp\u003eDepending on the chosen responseType, the Content-Type header of the response will be set to: - \u003ccode\u003etext/plain; charset=ISO-8859-1\u003c/code\u003e for base64 - \u003ccode\u003eapplication/octet-stream; charset=ISO-8859-1\u003c/code\u003e for binary - \u003ccode\u003eapplication/json\u003c/code\u003e for path\u003c/p\u003e ",
"enum": [
"base64",
"binary",
"path"
],
"example": "path",
"title": "DownloadResponseType",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The keywords in the CSV file are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"downloadURL": {
"description": "\u003cp\u003e\u003cstrong\u003eThe URL to the converted FileBasic.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e, \u003ccode\u003eresponseType: path\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: directLink\u003c/code\u003e: The directLink.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: path\u003c/code\u003e: This URL is valid for 24 hours.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
},
"application/octet-stream; charset=ISO-8859-1": {
"schema": {
"format": "binary",
"type": "string"
}
},
"text/plain; charset=ISO-8859-1": {
"schema": {
"format": "base64",
"type": "string"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "KeywordsDownloadCSV",
"tags": [
"Keywords"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003ekeywordsUploadCSV\u003c/code\u003e endpoint allows you to upload keyword data to pixx.io using a CSV file.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful when managing keywords in bulk, such as when importing keyword sets across teams. It enables you to batch-import keywords and bind specific permission groups to them.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eThe file \u003cstrong\u003emust\u003c/strong\u003e be UTF-8 encoded.\u003c/li\u003e \u003cli\u003eThe format must adhere to the specification:\u003c/li\u003e \u003cli\u003eLine 1 (optional): delimiter for Excel parsing.\u003c/li\u003e \u003cli\u003eLine 2 (optional): column headers - exactly \u0026quot;Keyword\u0026quot; and \u0026quot;PermissionGroups\u0026quot;.\u003c/li\u003e \u003cli\u003eLine 3+: keyword and optional permission group assignments.\u003c/li\u003e \u003cli\u003eGroup restrictions apply only when the \u003ccode\u003ekeywordsBoundToPermissionGroups\u003c/code\u003e setting is enabled in pixxio.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "KeywordsUploadCSV",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"csvFieldDelimiter": {
"default": ";",
"description": "The CSV Field delimiter which separates the fields in a CSV record.",
"enum": [
"\t",
",",
";"
],
"example": ";",
"title": "CsvFieldDelimiter",
"type": "string"
},
"file": {
"description": "The binary-encoded UTF-8 CSV file containing keyword information to be uploaded.",
"format": "binary",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "KeywordsUploadCSV",
"tags": [
"Keywords"
]
}
},
"/api/v1/licenseReleases": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleasesDelete\u003c/code\u003e endpoint deletes one or more license releases from the pixx.io system. A license release links a license to specific files and defines its usage scope.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to remove outdated or incorrect license associations.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eThis operation only affects metadata; the files themselves are not deleted.\u003c/li\u003e \u003cli\u003eDeletion is permanent and requires appropriate permissions. \u003c/li\u003e \u003c/ul\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicenseReleasesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3335343934"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseReleasesDelete",
"tags": [
"License Releases"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleasesGet\u003c/code\u003e endpoint retrieves a paginated list of license releases from the pixx.io system. License releases define licensing information that applies to specific files.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to browse, filter, or administrate existing license releases and associated metadata.\u003c/p\u003e\n\u003ch3\u003ePerformance Note\u003c/h3\u003e\n\u003cp\u003eUse \u003ccode\u003eresponseFields\u003c/code\u003e to limit returned data and improve performance.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicenseReleasesGet",
"parameters": [
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3134343137"
}
},
{
"in": "query",
"name": "licenseResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6338653162"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The ISO language code of the response (e.g., 'en', 'de').",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "licenseIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3564343231"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Filters license releases whose name includes this search term.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "showDeleted",
"schema": {
"description": "Include deleted license releases in the result.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Disables translation fallback if set to true.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"licenseReleases": {
"items": {
"$ref": "#/components/schemas/LicenseRelease"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseReleasesGet",
"tags": [
"License Releases"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleasesPost\u003c/code\u003e endpoint creates a new license release in the pixx.io system. A license release associates licensing metadata with specific files.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this when assigning a new license to one or more files.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eYou can optionally link to an existing license ID or just provide metadata.\u003c/li\u003e \u003cli\u003eIf file IDs are provided, the license release will be associated with those files. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "LicenseReleasePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3663393036"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseReleasePost",
"tags": [
"License Releases"
]
}
},
"/api/v1/licenseReleases/{licenseReleaseID}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleaseGet\u003c/code\u003e endpoint retrieves detailed information about a specific license release associated with a file in the pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is typically used by systems or administrators reviewing license metadata related to digital assets, ensuring compliance with licensing agreements.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eYou must know the unique ID of the license release to query it.\u003c/li\u003e \u003cli\u003eReturned data includes associated expiration, grant details, and references. \u003c/li\u003e \u003c/ul\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicenseReleaseGet",
"parameters": [
{
"in": "path",
"name": "licenseReleaseID",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the response. Defaults to system language if not specified.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Disables translation fallback if set to true.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3134343137"
}
},
{
"in": "query",
"name": "licenseResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6338653162"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"licenseRelease": {
"$ref": "#/components/schemas/LicenseRelease"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseReleaseGet",
"tags": [
"License Releases"
]
}
},
"/api/v1/licenseReleases/{licenseRelease_id}": {
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseReleasePut\u003c/code\u003e endpoint updates an existing license release in the pixx.io system. A license release holds metadata about the usage rights of a file.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to modify license properties, such as description, visibility, or linked license entity.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eUse only if you have sufficient permissions to modify license data.\u003c/li\u003e \u003cli\u003eThe actual file content is not changed, only the associated metadata. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "LicenseReleasePut",
"parameters": [
{
"in": "path",
"name": "licenseRelease_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"color": {
"description": "Hex color code of the license release.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"contentToAdd": {
"$ref": "#/components/schemas/ArrayOfLicenseData"
},
"contentToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6431643662"
},
"deleteFile": {
"description": "True if the assigned file should be deleted.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"description": {
"description": "The updated description for the license release.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"file": {
"description": " The file which is assigned to the licenseRelease. The file has to have the fileExtension .pdf.",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "Optional name for the uploaded file. Do not include file extension. Only if parameter file is set.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"name": {
"description": "The updated name of the license release.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"releaseCreateDate": {
"description": "The updated releaseCreateDate for the license release.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "Flag indicating whether the release file is visible to all users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"description": "Flag indicating whether a warning message should be shown.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateReleaseCreateDate": {
"description": "True if releaseCreateDate should be unset.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateWarningMessage": {
"description": "True if the warningMessage should be removed.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "The warning message to display if ShowWarningMessage is true.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseReleasePut",
"tags": [
"License Releases"
]
}
},
"/api/v1/licenses": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003elicensesDelete\u003c/code\u003e endpoint allows you to remove one or more licenses from your pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful when cleaning up outdated licensing information from your system.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eWhen deleting a license, all licenseReleases belonging to this license will be deleted as well.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicensesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicensesDelete",
"tags": [
"Licenses"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003elicensesGet\u003c/code\u003e endpoint allows you to retrieve a paginated list of licenses that exist within your pixx.io system. Licenses help you manage and control the usage rights of your files and ensure compliance with media distribution requirements.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is particularly useful when managing large numbers of licenses, applying filters by provider, and retrieving specific metadata related to license releases.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eUse either \u003ccode\u003esearchTerm\u003c/code\u003e, \u003ccode\u003esearchReleaseIDs\u003c/code\u003e, or \u003ccode\u003eprovider\u003c/code\u003e — not multiple at once.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicensesGet",
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731366165"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6332613864"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"provider"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "searchReleaseIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6162313334"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "\u003cp\u003eReturn licenses and licenseReleases based on matching provider or release name. If \u003ccode\u003elicenseReleases\u003c/code\u003e is not specified in the responseFields only licenses are returned that match the searchTerm. If \u003ccode\u003elicenseReleases\u003c/code\u003e is specified in the responseFields, all licenses who match the searchTerm as well as all licenses who have at least one licenseRelease that matches the searchTerm are returned. In this case not all licenseReleases of that license are returned but only the ones whose name contains the searchTerm. \u003cstrong\u003eAt most one of the parameters searchTerm, searchReleaseIDs, provider shall be set.\u003c/strong\u003e\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"description": "\u003cp\u003eFilters for all licenses with the specified provider (wildcard search). \u003cstrong\u003eAt most one of the parameters searchTerm, searchReleaseIDs, provider shall be set.\u003c/strong\u003e\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"licenses": {
"items": {
"$ref": "#/components/schemas/License"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicensesGet",
"tags": [
"Licenses"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003elicensesPost\u003c/code\u003e endpoint allows you to register a new license provider in your pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to create a new license provider record that can later be used to create licenseReleases under this provider.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "LicensePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3430303332"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicensePost",
"tags": [
"Licenses"
]
}
},
"/api/v1/licenses/{license_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003elicenseGet\u003c/code\u003e endpoint allows you to retrieve detailed information about a specific license within your pixx.io system. A license may have associated releases, metadata, and additional state indicators that help manage usage rights and restrictions.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is typically used to access all relevant metadata of a license and its attached releases, for instance, when verifying media rights or preparing content for publication.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "LicenseGet",
"parameters": [
{
"in": "path",
"name": "license_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6332613864"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731366165"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"license": {
"$ref": "#/components/schemas/License"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicenseGet",
"tags": [
"Licenses"
]
},
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003elicensePut\u003c/code\u003e endpoint allows you to update the provider of a license in your pixx.io system.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "LicensePut",
"parameters": [
{
"in": "path",
"name": "license_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"provider": {
"description": "a string term\u003cbr\u003e\u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e The provider must be unique. Using a provider already in use will cause a permission error.\u003c/p\u003e ",
"example": "ABC-Media",
"title": "Term",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "LicensePut",
"tags": [
"Licenses"
]
}
},
"/api/v1/metadata/custom": {
"get": {
"description": "\u003cp\u003eThe customMetadatasGet endpoint allows you to retrieve existing custom metadata in pixx.io. Custom metadata is a powerful feature that allows you to add additional information to your assets, making them more searchable and organized.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested custom metadata.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "CustomMetadatasGet",
"parameters": [
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "The elements in the customMetadata attribute of the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "id",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3230663233"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"customMetadata": {
"$ref": "#/components/schemas/ArraySchema_6634396663"
},
"quantity": {
"description": "The total number of customMetadata.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CustomMetadatasGet",
"tags": [
"Custom Metadata"
]
}
},
"/api/v1/metadata/custom/{custom_metadata_id}": {
"get": {
"description": "\u003cp\u003eThe customMetadataGet endpoint allows you to retrieve a specific existing custom metadata in pixx.io. Custom Metadata is a powerful feature that allows you to add additional information to your assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested asset navigator.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "CustomMetadataGet",
"parameters": [
{
"in": "path",
"name": "custom_metadata_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3230663233"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the response. The default language is the system language.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"customMetadata": {
"$ref": "#/components/schemas/CustomMetadata_6665623532"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "CustomMetadataGet",
"tags": [
"Custom Metadata"
]
}
},
"/api/v1/metadata/important": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eimportantMetadataGet\u003c/code\u003e endpoint allows you to retrieve all metadata fields that are marked as important in your pixx.io system. An important metadata field can be one of the following types: - \u003ccode\u003ecustom\u003c/code\u003e - custom metadata fields created by the user (can be of editType text, map, date, multi-selection etc.) - \u003ccode\u003eexif\u003c/code\u003e, \u003ccode\u003eiptc\u003c/code\u003e, \u003ccode\u003exmp\u003c/code\u003e - also referred to as \u003ccode\u003estandard\u003c/code\u003e metadata fields - these are metadata fields that are automatically extracted from the file when it is uploaded. - \u003ccode\u003einternal\u003c/code\u003e - internal metadata fields that are used by pixxio to store information about the file (e.g., \u003ccode\u003ecreateDate\u003c/code\u003e, \u003ccode\u003erating\u003c/code\u003e, \u003ccode\u003efileSize\u003c/code\u003e) that serve a certain purpose in pixxio.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint when building UIs that need to know which metadata fields are essential to a customer's workflows and are therefore part of the 'important' metadata. It helps in rendering metadata editors or search views efficiently.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eAll metadata fields that are shown in the UI settings in the 'metadata' section are important metadata fields.\u003c/li\u003e \u003cli\u003eImportant metadata fields appear in the file view at the top of the metadata list, they can be ordered (in the UI settings via drag \u0026amp; drop) so that they appear in a specific order.\u003c/li\u003e \u003cli\u003eCustom metadata fields are always important - these can be created freely without any restrictions in the UI settings.\u003c/li\u003e \u003cli\u003eStandard (exif, iptc, xmp) and internal metadata fields on the other hand can not be created completely freely, you can only choose from a list of available standard and internal metadata fields when adding them in the UI settings.\u003c/li\u003e \u003cli\u003eEach item in the response includes a top-level id field. This id does not represent the unique identifier of the actual metadata field itself. Instead, it identifies the important metadata entry — which is mainly used to control the ordering of metadata fields in the UI. If you need the true identifier of the underlying metadata field (e.g., for editing or referencing it elsewhere), you should use the metadata.id property inside the object.\u003c/li\u003e \u003cli\u003eWhen uploading a new file, only the standard (and some internal metadata fields) are automatically extracted from the file and filled in - custom metadata fields are not filled in automatically and always need to be filled in manually by the user or a script.\u003c/li\u003e \u003cli\u003eAll other extracted standard metadata fields during upload that are not part of the important metadata fields are only visible in the file view at the very bottom after clicking on \u0026quot;show all metadata\u0026quot;.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ImportantMetadataGet",
"parameters": [
{
"in": "query",
"name": "isSearchable",
"schema": {
"description": "Filters metadata fields by their isSearchable property.\u003cbr\u003eIf an important metadata is searchable was specified by the user when he added the metadata field in the UI",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3532363535"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"importantMetadata": {
"items": {
"$ref": "#/components/schemas/ImportantMetadata"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ImportantMetadataGet",
"tags": [
"Important Metadata"
]
}
},
"/api/v1/metadata/internal": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003einternalMetadataGet\u003c/code\u003e endpoint allows you to retrieve all available internal metadata fields. This list is static and does not change based on the files in your system or the metadata fields you have created in the settings. These metadata fields are typically used for internal logic or categorization, i.e. fileSize, fileType, rating, createDate, etc. Some of these are editable for a file (using the Files PUT endpoint), while others are not. When using the File PUT endpoint to modify an internal metadata field, you can usually find a top-level parameter that is used to modify a specific field for the file (i.e. \u003ccode\u003erating\u003c/code\u003e). Therefore, you do not need to know the ID of the internal metadata field. This differs from standard / custom metadata modifying, because for these types one has to know the ID of the standard / custom metadata field and specify them in the array-parameters \u0026quot;metadataStandard\u0026quot; and \u0026quot;metadataCustom\u0026quot; of the Files PUT request in order to modify them for the file).\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint can be used to list all internal metadata fields and get their IDs. The IDs are only useful if you want to call the PUT Internal Metadata Endpoint to set a specific internal metadata field as important.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "InternalMetadataGet",
"parameters": [
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Filters internal metadata fields based on their name (case-insensitive partial match).",
"example": "copyright",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"internalMetadata": {
"items": {
"$ref": "#/components/schemas/InternalMetadata"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "InternalMetadataGet",
"tags": [
"Internal Metadata"
]
}
},
"/api/v1/metadata/standard": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003estandardMetadataGet\u003c/code\u003e endpoint allows you to retrieve the available standard metadata fields configured in your pixx.io instance. The term standard metadata refers to metadata fields of the standards EXIF, IPTC, and XMP. The returned metadata fields are not mediaspace-specific, this is a fixed list of standard metadata fields supported by pixx.io\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint when you need to query available standard metadata fields in order to get their ID that can for example be used for filtering files.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "StandardMetadataGet",
"parameters": [
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3838346637"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Filters the standardMetadata via wildcard term.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"standardMetadata": {
"items": {
"$ref": "#/components/schemas/StandardMetadata"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "StandardMetadataGet",
"tags": [
"Standard Metadata"
]
}
},
"/api/v1/metadataFields": {
"get": {
"deprecated": true,
"description": "\u003cp\u003eDeprecated: This endpoint is deprecated and will be removed in the near future. Please use the \u003ccode\u003eGET /metadata/important\u003c/code\u003e endpoint instead to retrieve important metadata fields and use the following endpoints to retrieve or filter standard and custom metadata fields and their properties: - \u003ccode\u003eGET /metadata/custom\u003c/code\u003e - \u003ccode\u003eGET /metadata/standard\u003c/code\u003e\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "MetadataFieldsGet",
"parameters": [
{
"in": "query",
"name": "editTypes",
"schema": {
"$ref": "#/components/schemas/ArrayOfMetadataFieldEditType"
}
},
{
"in": "query",
"name": "isImportant",
"schema": {
"description": "Filters the metadataFields by the important fields (true) or not important fields (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isSearchable",
"schema": {
"description": "Filters the metadataFields by the searchable fields (true) or not searchable fields (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "metadataFieldIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6238646264"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the metadataFields by the specified name (wildcard search).",
"example": "Author",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 100,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6237306637"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"editType",
"id",
"modifyDate",
"name",
"order",
"type"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "types",
"schema": {
"$ref": "#/components/schemas/ArrayOfMetadataFieldType"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"metadataFields": {
"items": {
"$ref": "#/components/schemas/MetadataField"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "MetadataFieldsGet",
"tags": [
"Metadata Fields"
]
}
},
"/api/v1/modelReleases": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleasesDelete\u003c/code\u003e endpoint allows the deletion of a specific model release document associated with a file in the pixx.io system.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is commonly used when outdated or incorrect model release documents need to be removed, or when files are cleaned up for legal or organizational purposes.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eDeletion is permanent and cannot be undone.\u003c/li\u003e \u003cli\u003eMake sure the model release is not actively referenced before deletion. \u003c/li\u003e \u003c/ul\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ModelReleasesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3438333439"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelReleasesDelete",
"tags": [
"Model Releases"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleasesGet\u003c/code\u003e endpoint retrieves a paginated list of model releases from the pixx.io system. Model releases are legal agreements that provide usage rights for images or footage of individuals.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to search, browse, or administrate model releases based on file, user, or name.\u003c/p\u003e\n\u003ch3\u003ePerformance Note\u003c/h3\u003e\n\u003cp\u003eUse \u003ccode\u003eresponseFields\u003c/code\u003e to reduce payload size and improve performance.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ModelReleasesGet",
"parameters": [
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6466633964"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "Sorts the result set by the specified field.",
"enum": [
"createDate",
"id",
"modifyDate",
"name",
"releaseCreateDate"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "Sorts the result in ascending or descending order.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "fileID",
"schema": {
"description": "Filter model releases that are linked to the specified file ID.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "userID",
"schema": {
"description": "Filter model releases created by the specified user.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Filter for model releases with names containing this term (wildcard search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "showDeleted",
"schema": {
"description": "If true, includes deleted model releases in the result.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "modelIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3736653937"
}
},
{
"in": "query",
"name": "modelResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3461616264"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "Language of the model release translation (e.g., 'de', 'en').",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivates translation fallback if no translation is available.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"modelReleases": {
"items": {
"$ref": "#/components/schemas/ModelRelease"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelReleasesGet",
"tags": [
"Model Releases"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleasesPost\u003c/code\u003e endpoint creates a new model release in the pixx.io system. A model release is a legal agreement that grants permission to use images or videos of an individual.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to link a model's consent to one or more media files by creating a model release entry.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eThe model release does not change file content, only associates legal metadata.\u003c/li\u003e \u003cli\u003eYou can optionally associate files and a person entity at creation time. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "ModelReleasePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3763383933"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelReleasePost",
"tags": [
"Model Releases"
]
}
},
"/api/v1/modelReleases/{modelRelease_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleaseGet\u003c/code\u003e endpoint retrieves detailed information about a specific model release in the pixx.io system. A model release is a legal document that grants permission to use images or videos of a person.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to inspect the metadata of a model release, including the model's identity and consent scope.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ModelReleaseGet",
"parameters": [
{
"in": "path",
"name": "modelRelease_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "The language of the modelRelease.",
"example": "af",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "If true, disables translation fallback if no translation exists.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3330343636"
}
},
{
"in": "query",
"name": "modelResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3936383835"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"modelRelease": {
"$ref": "#/components/schemas/ModelRelease"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelReleaseGet",
"tags": [
"Model Releases"
]
},
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003emodelReleasePut\u003c/code\u003e endpoint updates the metadata of an existing model release in the pixx.io system. Model releases document the permission granted by individuals to use their likeness in media.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to correct or enhance metadata about the person, release content, or associated file.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eOnly metadata is updated — the linked file and content remain unchanged.\u003c/li\u003e \u003cli\u003ePermissions are required for update operations. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "ModelReleasePut",
"parameters": [
{
"in": "path",
"name": "modelRelease_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"color": {
"description": "The updated color of the model release (HEX format).",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"deleteFile": {
"description": "If true, the assigned file will be removed.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"file": {
"description": "\u003cp\u003eThe file which is assigned to the propertyRelease. The file has to have the fileExtension .pdf. This field gets only handled when the request is multipart/form-data.\u003c/p\u003e ",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "New name for the uploaded file (without .pdf extension). Only if parameter file is set.",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"name": {
"description": "The updated name of the model release.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"releaseCreateDate": {
"description": "New creation date of the model release.",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "Whether the file should be accessible in media view.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"description": "Whether to show a warning message with the release.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateReleaseCreateDate": {
"description": "If true, unsets the releaseCreateDate value.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateWarningMessage": {
"description": "If true, unsets the warningMessage.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "The warning message to show (required if showWarningMessage is true).",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelReleasePut",
"tags": [
"Model Releases"
]
}
},
"/api/v1/models": {
"delete": {
"description": "This is the BatchDeleteEndpoint of models.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ModelsDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelsDelete",
"tags": [
"Models"
]
},
"get": {
"description": "This is the Get-batchGetEndpoint of models.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: name, searchTerm, searchReleaseIDs",
"operationId": "ModelsGet",
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3264373538"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6231343137"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "\u003cp\u003eFilters for the specified name. Wildcard search in first- and last-name of model.\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "\u003cp\u003eFilters for the specified search-term. Wildcard search in first- and last-name of model and name of model-releases.\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "searchReleaseIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6665353530"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"birthDate",
"createDate",
"email",
"firstName",
"id",
"lastName",
"modifyDate"
],
"example": "lastName",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "name",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"models": {
"items": {
"$ref": "#/components/schemas/Model"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelsGet",
"tags": [
"Models"
]
},
"post": {
"description": "This is the Post-Endpoint of models.",
"operationId": "ModelPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_6237643966"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The id of the created model.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelPost",
"tags": [
"Models"
]
}
},
"/api/v1/models/{id}": {
"get": {
"description": "This is the Get-Endpoint of a model.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "ModelGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3264373538"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6231343137"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "name",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"model": {
"$ref": "#/components/schemas/Model"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelGet",
"tags": [
"Models"
]
},
"put": {
"description": "This is the Put-putEndpoint of a model.",
"operationId": "ModelPut",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"birthDate": {
"description": "A date in the format of YYYY-MM-DD. The underlying time.Time value will always be set to midnight",
"example": "2024-01-01",
"title": "Date",
"type": "string"
},
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"truncateBirthDate": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateEmail": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "ModelPut",
"tags": [
"Models"
]
}
},
"/api/v1/permissionGroups": {
"get": {
"description": "\u003cp\u003eThe permissionGroupsGet endpoint allows you to retrieve existing permission groups in pixx.io.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested permission groups.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PermissionGroupsGet",
"parameters": [
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "The elements in the permissionGroups attribute of the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the permissionGroups attribute of the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6664376237"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "The permissionGroups in the response contains only permissionGroups whose name contains this searchTerm.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "isAdmin",
"schema": {
"description": "Filters the permissionGroups for admin-permissionGroups.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isExternal",
"schema": {
"description": "Filters the permissionGroups for external permissionGroups (true) or internal permissionGroups (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isLinked",
"schema": {
"description": "Filters the permissionGroups for permissionGroups linked to an external identity manager (true) or internal users (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isReadOnly",
"schema": {
"description": "Filters the permissionGroups for readOnly permissionGroups (true) or not-readOnly permissionGroups (false).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 20,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"permissionGroups": {
"$ref": "#/components/schemas/ArraySchema_3936316338"
},
"quantity": {
"description": "The total number of permissionGroups.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PermissionGroupsGet",
"tags": [
"Permission Groups"
]
}
},
"/api/v1/permissionGroups/{permission_group_id}": {
"get": {
"description": "\u003cp\u003eThe permissionGroupsGet endpoint allows you to retrieve a specific permission group in pixx.io\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested permission group.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PermissionGroupGet",
"parameters": [
{
"in": "path",
"name": "permission_group_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3564306339"
}
},
{
"in": "query",
"name": "fileStatesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6461373734"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3538383463"
}
},
{
"in": "query",
"name": "directoriesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3230393038"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"permissionGroup": {
"$ref": "#/components/schemas/PermissionGroup_6565323865"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PermissionGroupGet",
"tags": [
"Permission Groups"
]
}
},
"/api/v1/portals": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalsGet\u003c/code\u003e endpoint allows you to retrieve the complete configuration and details of multiple portal instances in your pixx.io environment.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful for frontends or admin tools that need to display portal configuration or conditionally render UI elements based on portal settings.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalsGet",
"parameters": [
{
"in": "query",
"name": "heroBannerPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_3637656136"
}
},
{
"in": "query",
"name": "heroLogoPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_3563326235"
}
},
{
"in": "query",
"name": "brandingLogoPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption"
}
},
{
"in": "query",
"name": "collectionsPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6231613034"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesLimit",
"schema": {
"default": 4,
"description": "The maximum number of fileObjects for the preview files of each collection object in the response.",
"example": 105,
"maximum": 4,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731326163"
}
},
{
"in": "query",
"name": "collectionsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6538396137"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivates the translation fallback.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3531323066"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3265363562"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the portals by the specified name (Wildcard Search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portals": {
"items": {
"$ref": "#/components/schemas/Portal"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalsGet",
"tags": [
"Portals"
]
}
},
"/api/v1/portals/{portal_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalGet\u003c/code\u003e endpoint allows you to retrieve the complete configuration and details of a specific portal instance in your pixx.io environment.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful for frontends or admin tools that need to display portal configuration or conditionally render UI elements based on portal settings.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalGet",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "heroBannerPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_3637656136"
}
},
{
"in": "query",
"name": "heroLogoPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_3563326235"
}
},
{
"in": "query",
"name": "brandingLogoPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption"
}
},
{
"in": "query",
"name": "collectionsPreviewFileOptions",
"schema": {
"$ref": "#/components/schemas/ArrayOfPreviewFileOption_6231613034"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesLimit",
"schema": {
"default": 4,
"description": "The maximum number of fileObjects for the preview files of each collection object in the response.",
"example": 105,
"maximum": 4,
"minimum": 1,
"title": "PositiveInt",
"type": "integer"
}
},
{
"in": "query",
"name": "collectionsPreviewFilesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731326163"
}
},
{
"in": "query",
"name": "collectionsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6538396137"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivates the translation fallback.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3531323066"
}
},
{
"in": "query",
"name": "language",
"schema": {
"default": "de",
"description": "A language tag (BCP 47), given in canonical form. Input is case-insensitive and accepts the underscore separator, so \u003ccode\u003ezh-Hans\u003c/code\u003e, \u003ccode\u003ezh-hans\u003c/code\u003e and \u003ccode\u003ezh_hans\u003c/code\u003e all name the same locale. A region subtag is accepted but not kept: \u003ccode\u003ede-DE\u003c/code\u003e and \u003ccode\u003ede-AT\u003c/code\u003e are both returned as \u003ccode\u003ede\u003c/code\u003e. Script subtags are kept (\u003ccode\u003ezh-Hans\u003c/code\u003e), deprecated tags are replaced (\u003ccode\u003eji\u003c/code\u003e becomes \u003ccode\u003eyi\u003c/code\u003e).",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "licenseReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6332613864"
}
},
{
"in": "query",
"name": "modelReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6331646433"
}
},
{
"in": "query",
"name": "propertyReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6630366465"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6365323462"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portal": {
"$ref": "#/components/schemas/Portal"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalGet",
"tags": [
"Portals"
]
}
},
"/api/v1/portals/{portal_id}/externalShares": {
"post": {
"description": "This is the Post-Endpoint of externalShares.",
"operationId": "PortalExternalSharesPost",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_6332303135"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The ID of the created external-share.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"shareKey": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalExternalSharesPost",
"tags": [
"Portals"
]
}
},
"/api/v1/portals/{portal_id}/pages": {
"get": {
"description": "This is the Get-Endpoint of the portalPages.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalPagesGet",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6534613936"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the response.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Disables translation fallback if set to true.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portalPages": {
"items": {
"$ref": "#/components/schemas/PortalPage"
},
"type": "array"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalPagesGet",
"tags": [
"Portal Pages"
]
}
},
"/api/v1/portals/{portal_id}/users": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalUsersGet\u003c/code\u003e endpoint retrieves a paginated list of portal users from the pixx.io system. Portal users are typically external collaborators who have restricted access to shared content.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to manage, audit, or assign roles to external users in shared portals.\u003c/p\u003e\n\u003ch3\u003ePerformance Note\u003c/h3\u003e\n\u003cp\u003eUse \u003ccode\u003eresponseFields\u003c/code\u003e to optimize performance by limiting the returned fields.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalUsersGet",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "isActive",
"schema": {
"description": "Only show active or inactive users.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isDoubleOptInVerified",
"schema": {
"description": "Only show users who are (or are not) DoubleOptIn verified.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "The current page of paginated results.",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "Number of results per page (max 20).",
"example": 4,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Optional filter across email, first name, and last name.",
"example": "Example",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6638306438"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"email",
"firstName",
"id",
"isActive",
"isDoubleOptInVerified",
"lastName",
"modifyDate"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portalUsers": {
"items": {
"$ref": "#/components/schemas/PortalUser"
},
"type": "array"
},
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalUsersGet",
"tags": [
"Portal Users"
]
}
},
"/api/v1/portals/{portal_id}/users/current": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalUserGet\u003c/code\u003e endpoint retrieves detailed information about a specific portal user in the pixx.io system. Portal users are external or limited-access users who interact with collections and files via portals.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to inspect a portal user's account details, permissions, and usage information.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalUserGetCurrent",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6638306438"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portalUser": {
"$ref": "#/components/schemas/PortalUser"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalUserGetCurrent",
"tags": [
"Portal Users"
]
}
},
"/api/v1/portals/{portal_id}/users/{portalUser_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalUserGet\u003c/code\u003e endpoint retrieves detailed information about a specific portal user in the pixx.io system. Portal users are external or limited-access users who interact with collections and files via portals.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to inspect a portal user's account details, permissions, and usage information.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PortalUserGet",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "path",
"name": "portalUser_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6638306438"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"portalUser": {
"$ref": "#/components/schemas/PortalUser"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalUserGet",
"tags": [
"Portal Users"
]
}
},
"/api/v1/portals/{portal_id}/users/{portalUser_id}/confirmation": {
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003eportalUserConfirmation\u003c/code\u003e endpoint triggers the confirmation process for a portal user, typically by resending the invitation or activation email.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to re-invite or re-confirm access for a portal user who has not yet accepted their initial invitation.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eRequires a valid email address of an existing portal user.\u003c/li\u003e \u003cli\u003eThe email must be associated with a user who has not yet completed confirmation. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "PortalUserConfirmationPost",
"parameters": [
{
"in": "path",
"name": "portal_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "path",
"name": "portalUser_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3233386166"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PortalUserConfirmationPost",
"tags": [
"Portal Users"
]
}
},
"/api/v1/properties": {
"delete": {
"description": "\u003cp\u003eThe propertiesDelete endpoint allows you to remove existing properties in pixx.io\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful deletion, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertiesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3630626364"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertiesDelete",
"tags": [
"Properties"
]
},
"get": {
"description": "\u003cp\u003eThe propertiesGet endpoint empowers you to effortlessly fetch properties.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested properties.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e pagination is used here. If you want to learn more about Pagination, please refer to the 'General Information' section.\u003c/p\u003e \u003c/blockquote\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertiesGet",
"parameters": [
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "The elements in the properties attribute of the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the properties attribute of the response are sorted by this parameter.",
"enum": [
"address",
"createDate",
"id",
"modifyDate",
"name",
"owner"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"description": "\u003cp\u003eThe page which is returned in the customMetadata attribute of the response. The pageSize determines how many customMetadata are in each page.\u003c/p\u003e\n\u003cp\u003eImagine a pixx.io system with 500 customMetadata and the determined page 3 and pageSize 100. The customMetadata attribute in the response now contains 100 elements (determined by the pageSize) from file 201 to file 300 (determined by the page and pageSize).\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"description": "\u003cp\u003eThe pageSize which determines how many elements are present in the customMetadata attribute maximally.\u003c/p\u003e\n\u003cp\u003eImagine a pixx.io system with 500 customMetadata and the determined page 3 and pageSize 100. The customMetadata attribute in the response now contains 100 elements (determined by the pageSize) from file 201 to file 300 (determined by the page and pageSize).\u003c/p\u003e ",
"example": 4,
"maximum": 50,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3532303631"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6631313265"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "asc",
"description": "The elements in the propertyReleaseObject - Array of the propertyObject in the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the propertyReleaseObject - Array of the propertyObject in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "\u003cp\u003eFilters for all properties with the specified name (wildcard search).\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eAt most one of the parameters searchTerm,searchReleaseIDs, name shall be set.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "searchReleaseIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3438383333"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "\u003cp\u003eIf propertiesReleases is not specified in the responseFields: Return only properties whose name contains the searchTerm. If propertyReleases is specified in the responseFields: Return all properties whose name contains the searchTerm as well as all propertyReleases that belong to that property (even if they themselves don't contain the searchTerm) All properties that have a propertyRelease whose name contains the searchTerm (even if the property itself does not contain the searchTerm). In this case not all propertyReleases of that property are returned but only the ones whose name contains the searchTerm\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003eAt most one of the parameters searchTerm,searchReleaseIDs, name shall be set.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"properties": {
"$ref": "#/components/schemas/ArraySchema_3834366665"
},
"quantity": {
"description": "The number of properties.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertiesGet",
"tags": [
"Properties"
]
},
"post": {
"description": "\u003cp\u003eThe propertiesPost endpoint allows you to create properties in pixx.io.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details to create a property.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful creation, the endpoint responds with a status code 200 OK and provides information about the newly created property.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the structure of the request:\u003c/p\u003e ",
"operationId": "PropertyPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3431346139"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The id of the new property.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyPost",
"tags": [
"Properties"
]
}
},
"/api/v1/properties/{property_id}": {
"get": {
"description": "\u003cp\u003eThe propertyGet endpoint empowers you to effortlessly fetch a specific property.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested property.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertyGet",
"parameters": [
{
"in": "path",
"name": "property_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3532303631"
}
},
{
"in": "query",
"name": "releasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6537663233"
}
},
{
"in": "query",
"name": "releasesSortDirection",
"schema": {
"default": "asc",
"description": "The elements in the propertyReleaseObject - Array of the propertyObject in the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "releasesSortBy",
"schema": {
"default": "createDate",
"description": "The elements in the propertyReleaseObject - Array of the propertyObject in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"property": {
"$ref": "#/components/schemas/Property"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyGet",
"tags": [
"Properties"
]
},
"put": {
"description": "\u003cp\u003eThe propertyPut endpoint allows you to modify an existing property in pixx.io\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details you want to modify for the property.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful modification, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "PropertyPut",
"parameters": [
{
"in": "path",
"name": "property_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"address": {
"description": "The address of the property.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"name": {
"description": "\u003cp\u003eThe name of the property.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e The name of the property is unique. Specifying an already existing name will result in a permission error.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"owner": {
"description": "The owner of the property.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"truncateAddress": {
"description": "The address of the property is set to undefined.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateOwner": {
"description": "The owner of the property is set to undefined.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyPut",
"tags": [
"Properties"
]
}
},
"/api/v1/propertyReleases": {
"delete": {
"description": "\u003cp\u003eThe propertyReleasesDelete endpoint allows you to remove existing property releases in pixx.io.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful deletion, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertyReleasesDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3665346562"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyReleasesDelete",
"tags": [
"Property Releases"
]
},
"get": {
"description": "\u003cp\u003eThe propertyReleasesGet endpoint empowers you to effortlessly fetch property releases.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and furnishes details about the requested property release.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the layout of the request:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertyReleasesGet",
"parameters": [
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "The elements in the propertyReleases attribute of the response are sorted in the direction of this parameter.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "The elements in the propertyReleases attribute of the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"name",
"releaseCreateDate"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3930343466"
}
},
{
"in": "query",
"name": "propertyResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3139633563"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the propertyRelease.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"description": "Deactivate the translation fallback.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Filters the propertyReleases by the specified name (Wildcard Search).",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "propertyIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_3738316462"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"propertyReleases": {
"$ref": "#/components/schemas/ArraySchema_3235656130"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyReleasesGet",
"tags": [
"Property Releases"
]
},
"post": {
"description": "\u003cp\u003eThe propertyReleasesPost endpoint empowers you to create property releases in pixx.io.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details to create a property release.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful creation, the endpoint responds with a status code 200 OK and provides information about the newly created property release.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's the structure of the request:\u003c/p\u003e ",
"operationId": "PropertyReleasePost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_3333626632"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The id of the new property.",
"example": 83,
"title": "Int",
"type": "integer"
},
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyReleasePost",
"tags": [
"Property Releases"
]
}
},
"/api/v1/propertyReleases/{property_release_id}": {
"get": {
"description": "\u003cp\u003eThe propertyReleaseGet endpoint allows you to retrieve a specific existing property release in pixx.io\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and the property release details.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "PropertyReleaseGet",
"parameters": [
{
"in": "path",
"name": "property_release_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3136666163"
}
},
{
"in": "query",
"name": "propertyResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6238643232"
}
},
{
"in": "query",
"name": "language",
"schema": {
"description": "The language of the propertyRelease.",
"example": "de",
"format": "bcp47",
"title": "LanguageCode",
"type": "string"
}
},
{
"in": "query",
"name": "deactivateTranslationFallback",
"schema": {
"default": false,
"description": "Deactivate the translation fallback.",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"propertyRelease": {
"$ref": "#/components/schemas/PropertyRelease"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyReleaseGet",
"tags": [
"Property Releases"
]
},
"put": {
"description": "\u003cp\u003eThe propertyReleasePut endpoint allows you to update an existing property release in pixx.io.\u003c/p\u003e\n\u003ch3\u003eRequest Body\u003c/h3\u003e\n\u003cp\u003eThe request body should include the necessary details you want to update for the property release.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful update, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "PropertyReleasePut",
"parameters": [
{
"in": "path",
"name": "property_release_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"color": {
"description": "The color of the propertyRelease.",
"example": "7FCBC6",
"title": "HexColor",
"type": "string"
},
"deleteFile": {
"default": false,
"description": "The file assigned to the propertyRelease is deleted.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"file": {
"description": "\u003cp\u003eThe file which is assigned to the propertyRelease. The file has to have the fileExtension .pdf. This field gets only handled when the request is multipart/form-data.\u003c/p\u003e ",
"format": "binary",
"type": "string"
},
"fileName": {
"description": "\u003cp\u003eThe name of the propertyRelease.\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Do not specify the fileExtension here, the fileExtension .pdf is appended on the server. \u003cstrong\u003eOnly if parameter file is defined.\u003c/strong\u003e\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "file.jpg",
"title": "FileName",
"type": "string"
},
"name": {
"description": "\u003cp\u003eThe name of the propertyRelease. \u003cstrong\u003eCaution:\u003c/strong\u003e The name of the propertyRelease is unique. Specifying an already existing name will result in a permission error.\u003c/p\u003e ",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"releaseCreateDate": {
"description": "The createDate of the propertyRelease itself (not the entity in the pixx.io database).",
"example": "2024-01-02 14:10:03",
"title": "DateTime",
"type": "string"
},
"showFile": {
"description": "If the assigned file of the propertyRelease is accessible by all users in the mediaview. If false the file is only accessible in the property settings.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showWarningMessage": {
"description": "The flag indicates if a warning message should be set (1) or not (0).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateReleaseCreateDate": {
"description": "The releaseCreateDate of the propertyRelease is set to undefined.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateWarningMessage": {
"description": "The warningMessage of the propertyRelease is set to undefined.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"warningMessage": {
"description": "\u003cp\u003eThe flag indicates if a warning message should be set (1) or not (0).\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e Required if showWarningMessage: true.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "A string with any formatting",
"title": "String",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "PropertyReleasePut",
"tags": [
"Property Releases"
]
}
},
"/api/v1/synonymColumns": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003esynonymColumnsGet\u003c/code\u003e endpoint allows you to retrieve information about synonym columns from pixx.io. Synonyms are used to enhance search capabilities by allowing users to find assets using different terms.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "SynonymColumnsGet",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"synonymColumns": {
"$ref": "#/components/schemas/SynonymColumns"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "SynonymColumnsGet",
"tags": [
"Synonyms"
]
}
},
"/api/v1/synonyms": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003esynonymsDelete\u003c/code\u003e endpoint allows you to remove all or specific synonym data from pixx.io.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003emutual exclusion conditions of fields:\u003cbr\u003eout of the following fields only 0 or 1 can have a value: all, iDs",
"operationId": "SynonymsDelete",
"parameters": [
{
"in": "query",
"name": "all",
"schema": {
"description": "To delete all synonyms in the database. In Addition, all synonymColumns are set to undefined.",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "ids",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6535393834"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "SynonymsDelete",
"tags": [
"Synonyms"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003esynonyms\u003c/code\u003e GET endpoint allows you to retrieve information about synonyms present in the synonym-dictionary of your pixx.io workspace. Synonyms are used to enhance search capabilities by allowing users to find assets using different terms.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "SynonymsGet",
"parameters": [
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 500,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3731636439"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "Wildcard search term to filter all synonyms.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"synonym10",
"synonym11",
"synonym12",
"synonym13",
"synonym14",
"synonym15",
"synonym16",
"synonym17",
"synonym18",
"synonym19",
"synonym1",
"synonym20",
"synonym2",
"synonym3",
"synonym4",
"synonym5",
"synonym6",
"synonym7",
"synonym8",
"synonym9"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"synonyms": {
"items": {
"$ref": "#/components/schemas/Synonym"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "SynonymsGet",
"tags": [
"Synonyms"
]
}
},
"/api/v1/synonyms/csv": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003esynonymsDownloadCSV\u003c/code\u003e endpoint allows you to export the current synonym dictionary from your pixx.io media space in CSV format.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "SynonymsDownloadCSV",
"parameters": [
{
"in": "query",
"name": "csvFieldDelimiter",
"schema": {
"default": ",",
"description": "The CSV Field delimiter which separates the fields in a CSV record.",
"enum": [
"\t",
",",
";"
],
"example": ";",
"title": "CsvFieldDelimiter",
"type": "string"
}
},
{
"in": "query",
"name": "responseType",
"schema": {
"default": "path",
"description": "The response format of the CSV export. Based on this the Content-Type of the response changes.",
"enum": [
"base64",
"binary",
"path"
],
"example": "base64",
"title": "DownloadResponseType",
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The synonyms in the CSV file are sorted by this parameter.",
"enum": [
"createDate",
"id",
"modifyDate",
"synonym10",
"synonym11",
"synonym12",
"synonym13",
"synonym14",
"synonym15",
"synonym16",
"synonym17",
"synonym18",
"synonym19",
"synonym1",
"synonym20",
"synonym2",
"synonym3",
"synonym4",
"synonym5",
"synonym6",
"synonym7",
"synonym8",
"synonym9"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"downloadURL": {
"description": "\u003cp\u003e\u003cstrong\u003eThe URL to the converted FileBasic.\u003c/strong\u003e\u003c/p\u003e\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e only for \u003ccode\u003eresponseType: directLink\u003c/code\u003e, \u003ccode\u003eresponseType: path\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: directLink\u003c/code\u003e: The directLink.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eresponseType: path\u003c/code\u003e: This URL is valid for 24 hours.\u003c/p\u003e \u003c/blockquote\u003e ",
"example": "https://www.example.com/path/to/file?foo=bar#baz",
"title": "URL",
"type": "string"
},
"fileSize": {
"description": "The size of the file in bytes.",
"example": 1500,
"minimum": 0,
"title": "FileSize",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
},
"application/octet-stream; charset=ISO-8859-1": {
"schema": {
"format": "binary",
"type": "string"
}
},
"text/plain; charset=ISO-8859-1": {
"schema": {
"format": "base64",
"type": "string"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "SynonymsDownloadCSV",
"tags": [
"Synonyms"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003esynonymsUploadCSV\u003c/code\u003e endpoint allows you to upload synonym data to pixx.io using a CSV file.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is useful when managing synonyms in bulk, such as when importing synonym sets across teams. It enables you to batch-import synonyms.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eThe file \u003cstrong\u003emust\u003c/strong\u003e be UTF-8 encoded.\u003c/li\u003e \u003cli\u003eThe format must adhere to the specification:\u003c/li\u003e \u003cli\u003eLine 1 (optional): Delimiter for Excel parsing.\u003c/li\u003e \u003cli\u003eLine 2 (optional): Defines the names of the synonym columns. Existing synonym columns from the database are used when the name matches. New synonym columns are created when the specified column does not exist.\u003c/li\u003e \u003cli\u003eLine 3+: Contains synonym information, creating alternative keyword mappings.\u003c/li\u003e \u003cli\u003eCaution: Only a total of 20 synonym columns can be indexed in the database. Duplicate columns will result in an error.\u003c/li\u003e \u003c/ul\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "SynonymsUploadCSV",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"csvFieldDelimiter": {
"default": ";",
"description": "The CSV Field delimiter which separates the fields in a CSV record.",
"enum": [
"\t",
",",
";"
],
"example": ";",
"title": "CsvFieldDelimiter",
"type": "string"
},
"file": {
"description": "The binary-encoded UTF-8 CSV file containing synonym information to be uploaded.",
"format": "binary",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "SynonymsUploadCSV",
"tags": [
"Synonyms"
]
}
},
"/api/v1/uploadLinkUsers": {
"get": {
"description": "This is the Get-Endpoint of uploadLinkGuestUser.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UploadLinkUsersGet",
"parameters": [
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"guestUserNames": {
"$ref": "#/components/schemas/ArrayOfTerm"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinkUsersGet",
"tags": [
"Uploadlinks"
]
}
},
"/api/v1/uploadLinks": {
"delete": {
"description": "\u003cp\u003eThe \u003ccode\u003euploadLinksDelete\u003c/code\u003e endpoint allows you to delete one or more existing upload links within your pixx.io instance. Upload links are used to allow external users or systems to upload files directly into specific directories or projects.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this endpoint to revoke upload capabilities by removing active upload links. This is helpful for managing and securing file intake workflows, especially when links are no longer needed or have been shared externally.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UploadLinksDelete",
"parameters": [
{
"in": "query",
"name": "ids",
"required": true,
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6432343661"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinksDelete",
"tags": [
"Uploadlinks"
]
},
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003euploadLinksGet\u003c/code\u003e endpoint retrieves a list of all existing upload links in your pixx.io system. Each upload link allows secure external file uploads into a predefined directory.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is typically used in administrative dashboards to view, filter, and manage upload links. It supports retrieval of metadata such as names, descriptions, and total count.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UploadLinksGet",
"parameters": [
{
"in": "query",
"name": "name",
"schema": {
"description": "Optional filter by name using wildcard search.",
"example": "Example",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "isActive",
"schema": {
"description": "Only returns active upload links (expirationDate \u003e now).",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "userID",
"schema": {
"description": "Filters the uploadLinks by the specified user ID.",
"example": 12,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3230393165"
}
},
{
"in": "query",
"name": "directoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3062663037"
}
},
{
"in": "query",
"name": "fileStateResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields"
}
},
{
"in": "query",
"name": "licenseReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3037383362"
}
},
{
"in": "query",
"name": "modelReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3434616465"
}
},
{
"in": "query",
"name": "propertyReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6138383435"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3664663233"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "Page number to retrieve (1-based).",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "Max number of items to return per page (max 50).",
"example": 10,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "name",
"description": "Sort field for the result list.",
"enum": [
"createDate",
"expirationDate",
"id",
"modifyDate",
"name",
"userID"
],
"example": "id",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "Sort direction for the result list.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadLinks": {
"items": {
"$ref": "#/components/schemas/UploadLink"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinksGet",
"tags": [
"Uploadlinks"
]
},
"post": {
"description": "\u003cp\u003eThe \u003ccode\u003euploadLinksPost\u003c/code\u003e endpoint allows you to create a new upload link within your pixx.io system. Upload links enable external collaborators to upload files securely and directly into designated directories.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis is used when you want to provision new upload links for external contributors (e.g., photographers, agencies). It supports fine-grained control over release attachments, keywords, expiration settings, and notifications.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eYou can configure who receives the upload link via email and specify release requirements.\u003c/li\u003e \u003cli\u003eExpiration is managed through the \u003ccode\u003evalidityPeriod\u003c/code\u003e parameter.\u003c/li\u003e \u003cli\u003eOptional features like \u003ccode\u003euploadCondition\u003c/code\u003e and \u003ccode\u003efileStateID\u003c/code\u003e depend on the \u003ccode\u003ehasFeatureExpandedUploadLinks\u003c/code\u003e package. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "UploadLinkPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"description": {
"description": "The description of the uploadLink.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"directoryID": {
"description": "The directory the uploadLink points to.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"emails": {
"$ref": "#/components/schemas/ArrayOfEmailLanguage_3634653034"
},
"faceRecognitionDisabled": {
"description": "Defines if the files uploaded with this uploadLink should be disabled for face recognition.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"fileStateID": {
"description": "The fileState to assign to uploaded files.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"keywords": {
"$ref": "#/components/schemas/ArrayOfTerm_6133636362"
},
"licenseReleaseIDs": {
"$ref": "#/components/schemas/ArrayOfID_6134316562"
},
"modelReleaseIDs": {
"$ref": "#/components/schemas/ArrayOfID_6666323637"
},
"name": {
"description": "The name of the uploadLink.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"description": "The notification text in the emails.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"propertyReleaseIDs": {
"$ref": "#/components/schemas/ArrayOfID_6363346334"
},
"showAllLicenseReleases": {
"description": "If true, all license releases are included.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showAllModelReleases": {
"description": "If true, all model releases are included.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showAllPropertyReleases": {
"description": "If true, all property releases are included.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadCondition": {
"description": "The upload condition required to show the link.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"validityPeriod": {
"description": "Defines how long the upload link remains valid.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "An int with valid zero value \"0\".",
"example": 83,
"title": "Int",
"type": "integer"
},
"shareKey": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinkPost",
"tags": [
"Uploadlinks"
]
}
},
"/api/v1/uploadLinks/basicInfo": {
"get": {
"description": "This is the basicInfo-Endpoint of a uploadLink.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UploadLinkBasicInfo",
"parameters": [
{
"in": "query",
"name": "shareKey",
"required": true,
"schema": {
"description": "The key of the uploadLink.",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6232646565"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadLink": {
"$ref": "#/components/schemas/UploadLink_6666316563"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"none"
]
}
],
"summary": "UploadLinkBasicInfo",
"tags": [
"Uploadlinks"
]
}
},
"/api/v1/uploadLinks/{uploadlink_id}": {
"get": {
"description": "\u003cp\u003eThe \u003ccode\u003euploadLinkGet\u003c/code\u003e endpoint retrieves detailed information about a specific upload link configured in your pixx.io system. Upload links allow external contributors to securely upload files into your pixx.io workspace.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eThis endpoint is commonly used in administrative or audit contexts where access, status, and configuration of upload links must be verified.\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UploadLinkGet",
"parameters": [
{
"in": "path",
"name": "uploadlink_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3232323166"
}
},
{
"in": "query",
"name": "directoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6431323934"
}
},
{
"in": "query",
"name": "fileStateResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3037623030"
}
},
{
"in": "query",
"name": "licenseReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6332613864"
}
},
{
"in": "query",
"name": "modelReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6331646433"
}
},
{
"in": "query",
"name": "propertyReleasesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6630366465"
}
},
{
"in": "query",
"name": "userResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6235343563"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "The success of the request.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadLink": {
"$ref": "#/components/schemas/UploadLink_6666316563"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinkGet",
"tags": [
"Uploadlinks"
]
},
"put": {
"description": "\u003cp\u003eThe \u003ccode\u003euploadLinkPut\u003c/code\u003e endpoint updates an existing upload link in the pixx.io system. You can modify various properties of an upload link including the associated directory, releases, keywords, and more.\u003c/p\u003e\n\u003ch3\u003eUse Case\u003c/h3\u003e\n\u003cp\u003eUse this to adjust access control, update metadata, or reflect changing project needs for external uploads.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cul\u003e \u003cli\u003eUse \u003ccode\u003etruncate\u003c/code\u003e flags to explicitly remove optional values like description or fileState.\u003c/li\u003e \u003cli\u003eReplacing releases or keywords is additive/removal-based. You must track current values for clean updates.\u003c/li\u003e \u003cli\u003eRequires \u003ccode\u003ehasFeatureExpandedUploadLinks\u003c/code\u003e for advanced parameters like \u003ccode\u003euploadCondition\u003c/code\u003e or \u003ccode\u003efileStateID\u003c/code\u003e. \u003c/li\u003e \u003c/ul\u003e ",
"operationId": "UploadLinkPut",
"parameters": [
{
"in": "path",
"name": "uploadlink_id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"description": {
"description": "The new description for the upload link.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"directoryID": {
"description": "The ID of the target directory for uploaded files.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"emailsToAdd": {
"$ref": "#/components/schemas/ArrayOfEmailLanguage"
},
"faceRecognitionDisabled": {
"description": "Defines if the files uploaded with this uploadLink should be disabled for face recognition.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"fileStateID": {
"description": "Optional file state ID to apply to uploaded files.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"filesToAdd": {
"$ref": "#/components/schemas/ArrayOfFileInfo"
},
"isDisabled": {
"description": "If true, disables the upload link.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"keywordsToAdd": {
"$ref": "#/components/schemas/ArrayOfTerm_3636366534"
},
"keywordsToRemove": {
"$ref": "#/components/schemas/ArrayOfTerm_6630663734"
},
"licenseReleaseIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_3363323734"
},
"licenseReleaseIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6164656565"
},
"modelReleaseIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_3032313439"
},
"modelReleaseIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3766616665"
},
"name": {
"description": "The new name of the upload link.",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"notificationText": {
"description": "Optional notification message sent with upload confirmations.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"propertyReleaseIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_6131373737"
},
"propertyReleaseIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6263656132"
},
"showAllLicenseReleases": {
"description": "If true, shows all license releases to users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showAllModelReleases": {
"description": "If true, shows all model releases to users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"showAllPropertyReleases": {
"description": "If true, shows all property releases to users.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateDescription": {
"description": "Unset the description (sets it to undefined).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateFileStateID": {
"description": "Unset the fileStateID (sets it to no fileState).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateNotificationText": {
"description": "Unset the notificationText (sets it to undefined).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateUploadCondition": {
"description": "Unset the uploadCondition (sets it to undefined).",
"example": true,
"title": "Bool",
"type": "boolean"
},
"uploadCondition": {
"description": "Optional upload condition text shown to users before uploading.",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"validityPeriod": {
"description": "Defines the validity period for the upload link.",
"enum": [
"infinite",
"none",
"oneDay",
"oneMonth",
"oneWeek",
"threeDays",
"threeMonths",
"threeWeeks",
"twoWeeks"
],
"example": "oneDay",
"title": "ExternalShareValidityPeriod",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UploadLinkPut",
"tags": [
"Uploadlinks"
]
}
},
"/api/v1/users": {
"get": {
"description": "\u003cp\u003eThe usersGet endpoint allows you to retrieve information about user accounts from pixx.io. User accounts have assigned roles and permissions for accessing and managing assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides a list of user accounts along with their attributes and configurations.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UsersGet",
"parameters": [
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 100,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6232363936"
}
},
{
"in": "query",
"name": "permissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3738396163"
}
},
{
"in": "query",
"name": "homeDirectoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3131396338"
}
},
{
"in": "query",
"name": "apiKeysResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3466646564"
}
},
{
"in": "query",
"name": "searchTerm",
"schema": {
"description": "wildcard search in userName, firstName and lastName.",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
{
"in": "query",
"name": "permissionGroupIDs",
"schema": {
"$ref": "#/components/schemas/ArrayOfID_6539616663"
}
},
{
"in": "query",
"name": "isActive",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isReadOnly",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isExternal",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "isLinked",
"schema": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "userName",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"email",
"firstName",
"id",
"lastName",
"modifyDate",
"userName"
],
"example": "createDate",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "asc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"users": {
"items": {
"$ref": "#/components/schemas/User"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UsersGet",
"tags": [
"Users"
]
},
"post": {
"description": "\u003cp\u003eThe usersPost endpoint allows you to create new user accounts within pixx.io. Users can access and manage assets based on their assigned roles and permissions.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful creation, the endpoint responds with a status code 200 OK and provides information about the newly created user account.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eWhen creating new user accounts, ensure that the provided data is accurate and follows any required format or rules. Users can access and interact with the DAM system based on their assigned roles and permissions.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "UserPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectSchema_6238386166"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The id of the created user.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UserPost",
"tags": [
"Users"
]
}
},
"/api/v1/users/current": {
"get": {
"description": "\u003cp\u003eThe userGet endpoint allows you to retrieve detailed information about a specific user account from the pixx.io. User accounts have assigned roles and permissions for accessing and managing assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides detailed information about the requested user account.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UserGetCurrent",
"parameters": [
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3065323261"
}
},
{
"in": "query",
"name": "permissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3661346537"
}
},
{
"in": "query",
"name": "homeDirectoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3131396338"
}
},
{
"in": "query",
"name": "fileStatesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3335383636"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
},
{
"in": "query",
"name": "directoriesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3131396338"
}
},
{
"in": "query",
"name": "apiKeysResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3466646564"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/User"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UserGetCurrent",
"tags": [
"Users"
]
}
},
"/api/v1/users/{id}": {
"delete": {
"description": "\u003cp\u003eThe userDelete endpoint allows you to delete a specific user account from pixx.io. User accounts have assigned roles and permissions for accessing and managing assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful deletion, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint removes the specified user account from the DAM system. Make sure you have the necessary permissions and understand the implications of user deletions.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UserDelete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "newUserDataOwner",
"schema": {
"default": 1,
"description": "\u003cp\u003ethe data of the user to delete is transferred to this user. default: system admin (1)\u003c/p\u003e ",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "transferInOwnHomeDirectory",
"schema": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
{
"in": "query",
"name": "deleteUserData",
"schema": {
"default": false,
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"jobID": {
"description": "The ID of the asynchronous job that was started in the background. Use the Get JobID endpoint to check the status of the job and retrieve its results or any errors that occurred during execution.",
"example": 12,
"minimum": 0,
"title": "JobID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UserDelete",
"tags": [
"Users"
]
},
"get": {
"description": "\u003cp\u003eThe userGet endpoint allows you to retrieve detailed information about a specific user account from the pixx.io. User accounts have assigned roles and permissions for accessing and managing assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides detailed information about the requested user account.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "UserGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3065323261"
}
},
{
"in": "query",
"name": "permissionGroupsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3661346537"
}
},
{
"in": "query",
"name": "homeDirectoryResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3131396338"
}
},
{
"in": "query",
"name": "fileStatesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3335383636"
}
},
{
"in": "query",
"name": "downloadFormatsResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_6530326635"
}
},
{
"in": "query",
"name": "directoriesResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3131396338"
}
},
{
"in": "query",
"name": "apiKeysResponseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3466646564"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/User"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UserGet",
"tags": [
"Users"
]
},
"put": {
"description": "\u003cp\u003eThe userPut endpoint allows you to update information for a specific user account in pixx.io. User accounts have assigned roles and permissions for accessing and managing assets.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful update, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eWhen updating user account information, ensure that the provided data is accurate and follows any required format or rules. Users can access and interact with their pixx.io system based on their assigned roles and permissions.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "UserPut",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"email": {
"description": "Email is an Entity for an Email. Control Characters at the beginning and end of the name are removed. Control Characters inside the Email are replaced by one whitespace. The Email has to be valid according to RFC 1123.\u003cbr\u003e**Caution:** the email is unique",
"example": "testersohn@pixx.io",
"title": "Email",
"type": "string"
},
"encryptedPassword": {
"description": "An encrypted password.",
"example": "censored",
"title": "EncryptedPassword",
"type": "string"
},
"firstName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"isActive": {
"description": "A bool with valid zero value \"false\".\u003cbr\u003eonly activated users are able to use pixx.io",
"example": true,
"title": "Bool",
"type": "boolean"
},
"isExternal": {
"description": "A bool with valid zero value \"false\".\u003cbr\u003eonly external users are able to be linked to an external identity manager.",
"example": true,
"title": "Bool",
"type": "boolean"
},
"language": {
"description": "language",
"enum": [
"de",
"en",
"fr",
"it",
"nl"
],
"example": "de",
"title": "Language",
"type": "string"
},
"lastName": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
},
"password": {
"description": "A password.",
"example": "censored",
"title": "Password",
"type": "string"
},
"permissionGroupIDsToAdd": {
"$ref": "#/components/schemas/ArrayOfID_3536333730"
},
"permissionGroupIDsToRemove": {
"$ref": "#/components/schemas/ArrayOfID_6465373835"
},
"recreateRefreshToken": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"refreshTokenToMigrate": {
"description": "A token",
"example": "BqK8e8tj4l",
"title": "Token",
"type": "string"
},
"truncateFirstName": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"truncateLastName": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"twoFactorAuthSetUp": {
"description": "\u003cp\u003eIf false, the 2FA of the user gets reset and must be set up again on the next login attempt. Can only be manually set to false, never to true.\u003c/p\u003e ",
"example": true,
"title": "Bool",
"type": "boolean"
},
"userName": {
"description": "A Username\u003cbr\u003e**Caution:** the userName is unique",
"example": "myUsername123",
"title": "UserName",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "UserPut",
"tags": [
"Users"
]
}
},
"/api/v1/variantStacks": {
"get": {
"description": "\u003cp\u003eThe variantStacksGet endpoint allows you to retrieve information about all variant stacks within pixx.io. Variant stacks consist of different files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides a list of all variant stacks along with their attributes and configurations.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "VariantStacksGet",
"parameters": [
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"description": "\u003cp\u003e\u0026quot;The page of the entries which is returned in the response. Imagine a pixx.io system with 800 entries and the determined page 3 and pageSize 20. The entries in the response now contains 20 elements (determined by the pageSize) from entry 41 to entry 60 (determined by the page and pageSize).\u0026quot;\u003c/p\u003e ",
"example": 4,
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "pageSize",
"required": true,
"schema": {
"description": "The maximum number of entries returned in a single response.",
"example": 4,
"maximum": 20,
"minimum": 0,
"title": "PageSize",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3137636234"
}
},
{
"in": "query",
"name": "sortBy",
"schema": {
"default": "createDate",
"description": "The elements in the response are sorted by this parameter.",
"enum": [
"createDate",
"modifyDate",
"name"
],
"example": "name",
"title": "SortBy",
"type": "string"
}
},
{
"in": "query",
"name": "sortDirection",
"schema": {
"default": "desc",
"description": "A sort direction.",
"enum": [
"asc",
"asc",
"desc",
"desc"
],
"example": "asc",
"title": "SortDirection",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"quantity": {
"description": "How many entries are found. Due to pagination the quantity might not necessarily be equal to the total length.",
"example": 12,
"minimum": 0,
"title": "Quantity",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"variantStacks": {
"items": {
"$ref": "#/components/schemas/VariantStack"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "VariantStacksGet",
"tags": [
"Variant Stacks"
]
},
"post": {
"description": "\u003cp\u003eThe variantStacksPost endpoint allows you to create a new variant stack in pixx.io. A variant stack consists of different files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful creation, the endpoint responds with a status code 200 OK and provides information about the newly created variant stack.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eWhen creating a new variant stack, ensure that the provided data is accurate and follows any required format or rules. Variant stacks consist of files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "VariantStackPost",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"description": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"files": {
"$ref": "#/components/schemas/ArrayOfFileVariantInfo_6165383237"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "The id of the created variant-stack.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
},
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "VariantStackPost",
"tags": [
"Variant Stacks"
]
}
},
"/api/v1/variantStacks/{id}": {
"delete": {
"description": "\u003cp\u003eThe variantStackDelete endpoint allows you to delete a specific variant stack from pixx.io. A variant stack consists of different files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful deletion, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eUsing this endpoint removes the specified variant stack from your pixx.io system. Make sure you have the necessary permissions and understand the implications of variant stack deletions.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "VariantStackDelete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "VariantStackDelete",
"tags": [
"Variant Stacks"
]
},
"get": {
"description": "\u003cp\u003eThe variantStackGet endpoint allows you to retrieve information about a specific variant stack from pixx.io. A variant stack consists of different files that are variants of each other, providing multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful retrieval, the endpoint responds with a status code 200 OK and provides detailed information about the requested variant stack, including its associated files.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e",
"operationId": "VariantStackGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
{
"in": "query",
"name": "responseFields",
"schema": {
"$ref": "#/components/schemas/ArrayOfResponseFields_3137636234"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
},
"variantStack": {
"$ref": "#/components/schemas/VariantStack"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "VariantStackGet",
"tags": [
"Variant Stacks"
]
},
"put": {
"description": "\u003cp\u003eThe variantStackPut endpoint allows you to update information for a specific variant stack in pixx.io. A variant stack consists of different files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eResponse\u003c/h3\u003e\n\u003cp\u003eUpon successful update, the endpoint responds with a status code 200 OK.\u003c/p\u003e\n\u003ch3\u003eImportant Considerations\u003c/h3\u003e\n\u003cp\u003eWhen updating a variant stack, ensure that the provided data is accurate and follows any required format or rules. Variant stacks consist of files that are variants of each other, offering multiple options for the same asset.\u003c/p\u003e\n\u003ch3\u003eRequest Structure\u003c/h3\u003e\n\u003cp\u003eHere's how the request is structured:\u003c/p\u003e ",
"operationId": "VariantStackPut",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "An ID is a number bigger than 0.",
"example": 5,
"minimum": 1,
"title": "ID",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"description": {
"description": "A string with valid zero value \"\".",
"example": "A string with any formatting",
"title": "String",
"type": "string"
},
"filesToAdd": {
"$ref": "#/components/schemas/ArrayOfFileVariantInfo"
},
"filesToRemove": {
"$ref": "#/components/schemas/ArrayOfID_3838613731"
},
"name": {
"description": "a string term",
"example": "aaaAA",
"title": "Term",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"description": "A bool with valid zero value \"false\".",
"example": true,
"title": "Bool",
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "\u003cbr\u003e\u003cbr\u003e"
}
},
"security": [
{
"Authorization": [
"apikey"
]
}
],
"summary": "VariantStackPut",
"tags": [
"Variant Stacks"
]
}
}
},
"servers": [
{
"url": "https://[EXAMPLE-MEDIASPACE].px.media/"
}
]
}