{"openapi":"3.0.1","info":{"title":"Portfolio REST API","description":"Welcome to the Portfolio REST API reference. This documentation is for developers who are creating applications that need to communicate with the Portfolio Server.
If you have a Portfolio server instance available, you can enter a url such as \"http://server-address:8090/api/openapi.json\"and test the API using swagger's \"Try It Out\" feature.
Some of the things that can be accomplished with the Portfolio API are:
• Upload and add assets to a Portfolio catalog.
• Retrieve thumbnails, previews, and asset metadata from a catalog.
• Search for assets based on asset metadata.
• Convert images and video to multiple formats.
• Retrieve original or converted versions of cataloged assets.
• Update asset metadata.
• Add assets to and remove assets from galleries.
• Retrieve galleries and folders.
• Lock and unlock assets.
","version":"1.0"},"servers":[{"url":"/api","variables":{}}],"paths":{"/_api_version":{"get":{"tags":["global"],"summary":"Get the API version","description":"Get the API version","operationId":"getApiVersion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersionResponseModel"}}}}}}},"/v1/catalog/{catalog_id}/lock":{"post":{"tags":["asset","catalog"],"summary":"Lock the specified assets","description":"Lock the specified assets. Locked Assets cannot be downloaded or edited by any users.
Note that only Vault-based Catalogs support locking.
Assets are specified by an array of asset IDs.
Request Format:{\"values\": [142, 145, 289]}
Response Format:{\"failures]\":{\"142\":\"ASSET_LOCKED\"}}
Any assets that cannot be locked will be identified by their ID and one of the following in the response:\n| Error code |
\n| ASSET_CHECKED_OUT |
\n| ASSET_LOCKED |
\n| NOT_FOUND |
\n| UNEXPECTED_ERROR |
\n
","operationId":"lock","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Asset ids to lock","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockAssetsRequestModel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockAssetsResponseModel"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/field-definition":{"get":{"tags":["catalog"],"summary":"Retrieve field definitions","description":"Retrieve the FieldDefinitions for a catalog.
Fields are attributes of assets that are defined for a catalog. A FieldDefinition describes the field's data type, name, and other qualities.","operationId":"getFieldDefinitions","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"fieldNames","in":"query","description":"json array of field names to retrieve. If the array is empty, all fieldDefinitions for the catalog are returned.","schema":{"$ref":"#/components/schemas/JSONArray"}},{"name":"predefined_values","in":"query","description":"get the predefined values (or not)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Array of field definitions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDefinition"}}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/auth/login":{"post":{"tags":["authentication"],"summary":"Login","description":"Login to the asset service","operationId":"login","requestBody":{"description":"Username and encrypted password. The password is base-64 encoded and RSA encrypted with the public key retrieved from the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"description":"A session ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/auth/logout":{"post":{"tags":["authentication"],"summary":"Log out of the asset service","description":"Invalidate a currently active session","operationId":"logout","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/diff/left/{versionId_left}/right/{versionId_right}":{"get":{"tags":["asset","versioning"],"summary":"Get the differences between two asset versions","description":"Get the differences between two asset versions","operationId":"getDiff","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId_left","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId_right","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVersionsResponseModel"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/checkin":{"post":{"tags":["asset","catalog","versioning"],"operationId":"checkin","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"comment","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"text/json":{}}}}}},"/v1/catalog/{catalog_id}/revert":{"post":{"tags":["asset","catalog","versioning"],"operationId":"revert","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/checkout":{"post":{"tags":["asset","catalog","versioning"],"operationId":"checkout","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/_video":{"get":{"tags":["asset"],"summary":"Stream a video","description":"Stream a video asset. The video content can be either the disk preview, or, in the case of mp4 assets, the asset content. Range headers are supported.","operationId":"getVideo","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"source","in":"query","description":"either \"preview\" or \"original\"","schema":{"type":"string"}},{"name":"start","in":"query","schema":{"type":"string"}},{"name":"range","in":"header","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/job/run":{"post":{"tags":["job"],"summary":"Run Job","description":"Creates and starts an asynchronous Job on the server. The input to the Job is specified by an AssetQuery, and could be a simple list of Asset Ids, or an arbitrarily complex query. A new jobId is returned, which may be used to query the server for the Job's status, errors, or to cancel the Job.
For details on how to configure Tasks and Jobs, see the documentation of Jobs.
Request format:
{\n \"job\": {\n \"description\": \"JOB_TYPE_EDIT_ON_DISK\",\n \"sourceImage\": \"original\",\n \"tasks\": [\n {\n \"catalogId\": \"A0A428EE-E710-A1C4-5411-C99B8301BF18\",\n \"type\": \"convert\",\n \"settings\": \n [\n {\n \"name\": \"outputFileFormat\",\n \"value\": \"JPEG\"\n },{\n \"name\": \"colorMode\",\n \"value\": \"RGB\"\n },{\n \"name\": \"compressionQuality\",\n \"value\": \"95\"\n },{\n \"name\": \"resizeHeight\",\n \"value\": \"128\"\n },{\n \"name\": \"resizeType\",\n \"value\": \"fitWithin\"\n },{\n \"name\": \"resizeUnits\",\n \"value\": \"pixels\"\n },{\n \"name\": \"resizeWidth\",\n \"value\": \"256\"\n }\n ]\n },\n {\n \"type\": \"download\"\n }\n ]\n },\n \"query\": {\n \"term\" : {\n \"operator\" : \"equalValue\",\n \"field\" : \"Keywords\",\n \"values\" : [\"dog\"],\n }\n }\n}\n
\n","operationId":"runJob","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Asset query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunJobRequestModel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/importData":{"post":{"tags":["catalog"],"operationId":"importData","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"Filedata":{"$ref":"#/components/schemas/FormDataContentDisposition"},"filename":{"type":"string"},"jobDescription":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/server/status":{"get":{"tags":["global"],"summary":"Retrieve server errors","description":"Retrieve a list of server errors.","operationId":"getServerStatus","responses":{"200":{"description":"Array of localizable messages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocalizableMessage"}}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_ids}/_derivative":{"get":{"tags":["asset"],"summary":"Retrieve a derivative for the specified assets","description":"Response Format: The response format is dependent on a few things: \t- if async is true, then the result will be a string, specifically a job id, suitable for use with the other job facilities,
\t- if the query yields multiple assets, then the response will be a zip containing the requested derivatives,
- if the query yields a single asset, the server will stream it to the client directly.
","operationId":"getDerivativesByIds","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"asset_ids","in":"path","description":"asset ids, comma separated","required":true,"schema":{"type":"string"},"example":"28932,79203"},{"name":"async","in":"query","description":"execute the operation asynchronously (or not)","required":true,"schema":{"type":"boolean"}},{"name":"imageOptions","in":"query","description":"JSON object. Example:
{\n \"outputFileFormat\" : \"JPEG\",\n \"colorMode\" : \"RGB|CMYK|Grayscale\",\n \"resizeWidth\" : 512,\n \"resizeHeight\" : 600,\n \"compressionQuality\" : <1-100>,\n \"source\" : \"<preview|original>\",\n \"videoFrameTime\" : 3,\n \"resolution\" : 72,\n \"compressionType\" : \"None|Zip|JPEG|LZW\",\n \"endian\" : \"big|little\"\n}","required":true,"schema":{"type":"string","example":"{\"outputFileFormat\":\"JPEG\"}"}}],"responses":{"200":{"description":"For async=false, asset content or zip archive for multiple assets, for async=true, a Job ID","content":{"application/octet-stream":{},"text/plain":{}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset/_derivative":{"get":{"tags":["asset"],"summary":"Retrieve derivatives for assets by query","description":"Response Format: The response format is dependent on a few things: \t- if async is true, then the result will be a string, specifically a job id, suitable for use with the other job facilities,
\t- if the query yields multiple assets, then the response will be a zip containing the requested derivatives,
- if the query yields a single asset, the server will stream it to the client directly.
","operationId":"getDerivatives","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"JSON object. Example:
{\n \"galleryId\" : <string>,\n \"term\" : {\n \"operator\" : \"equalValue\",\n \"field\" : \"Keywords\",\n \"values\" : [\"dog\"],\n \"subqueries\" : [\n {\"operator\" : \"startsWithValue\", ...},\n {\"operator\" : \"greaterThanValue\",...}\n ]\n }\n}\n","required":true,"schema":{"type":"string","example":"{\"term\":{\"operator\":\"assetsById\",values:[\"12132\"]}}"}},{"name":"async","in":"query","description":"perform the operation asynchronously (or not)","schema":{"type":"boolean"}},{"name":"imageOptions","in":"query","description":"JSON object. Example:
{\n \"outputFileFormat\" : \"JPEG\",\n \"colorMode\" : \"RGB|CMYK|Grayscale\",\n \"resizeWidth\" : 512,\n \"resizeHeight\" : 600,\n \"compressionQuality\" : <1-100>,\n \"source\" : \"<preview|original>\",\n \"videoFrameTime\" : 3,\n \"resolution\" : 72,\n \"compressionType\" : \"None|Zip|JPEG|LZW\",\n \"endian\" : \"big|little\"\n}","required":true,"schema":{"type":"string","example":"{\"outputFileFormat\":\"JPEG\"}"}}],"responses":{"200":{"description":"For async=false, asset content or zip archive for multiple assets, for async=true, a Job ID","content":{"application/octet-stream":{},"text/plain":{}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/_content":{"get":{"tags":["asset"],"summary":"Stream the contents of an asset","description":"Get the content of the asset. HTTP Range headers are supported.","operationId":"streamAssetContent","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","description":"asset id","required":true,"schema":{"type":"string"}},{"name":"range","in":"header","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/thumbnail":{"get":{"tags":["asset"],"summary":"Get thumbnail image for specified asset","description":"Get thumbnail image for specified asset","operationId":"assetThumbnail","parameters":[{"name":"session","in":"query","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The thumbnail content"},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/preview":{"get":{"tags":["asset"],"summary":"Retrieve preview image for the specified asset","operationId":"assetPreview","parameters":[{"name":"session","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The preview content"},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog":{"get":{"tags":["catalog"],"summary":"Retrieve a list of catalogs","description":"Retrieves a list of all catalogs for which the currently logged in user has access/visibility.","operationId":"getCatalogs","parameters":[{"name":"session","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of catalogs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Catalog"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/properties/{property_list}":{"get":{"tags":["catalog"],"summary":"Retrieve a combination of several catalog properties and settings","description":"Retrieve a combination of several catalog properties and settings.
Sample Response Format:[\n\t{\n\t\t\"smartKeywordsSettings\": {\n\t\t\t\"enabled\": true\t\t}\n\t\t\"exclusionInfo\": {\n\t\t\t\"allowAllExtensions\": true,\n\t\t\t\"pathExclusions\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"startsWith\",\n\t\t\t\t\t\"value\": \".\"\n\t\t\t\t},\n...\n\t\t\t]\n\t\t},\n\t\t\"catalogingOptions\": {\n\t\t\t\"keywordsFromPathStyle\": 7,\n\t\t\t\"useConstrainedIngest\": true\n\t\t},\n\t\t\"ingestConfig\": {\n\t\t\t\"headerText\": \"Please enter the following information\",\n\t\t\t\"fields\": [\n\t\t\t]\n\t\t}\n\t}\n]
The property list is a token delimited combination of any of the following:\n- catalogingOptions
\n- exclusionInfo
\n- ingestConfig
\n- smartKeywordsSettings
\n","operationId":"getCatalogingProperties","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"property_list","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_ids}/_original":{"get":{"tags":["asset"],"summary":"Retrieve asset original for specified asset","description":"Retrieve asset originals for the specified asset ids.Asset ID list: The list is comma delimited with an optional version id preceded by a colon. Example: 5000:4,5002,5003:6Response Format: The response format is dependent on a few things: - if async is true, then the result will be a string, specifically a job id, suitable for use with the other job facilities,
- if the query yields multiple assets, then the response will be a zip containing the requested originals,
- if the query yields a single asset, the server will stream it to the client directly.
","operationId":"getOriginalsByIds","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"asset_ids","in":"path","description":"asset ids, comma separated","required":true,"schema":{"type":"string"}},{"name":"async","in":"query","description":"execute the operation asynchronously (or not)","schema":{"type":"boolean"}},{"name":"exact_binary","in":"query","description":"return exact binary without embedding metadata (vault only)","schema":{"type":"boolean"}},{"name":"for_checkout","in":"query","description":"optimization for checkin/checkout","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Job ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobIdResponse"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset/_original":{"get":{"tags":["asset"],"summary":"Download asset original(s) from server.","description":"Retrieve asset content for the assets matching the assetQueryQuery format:
{\n \"galleryId\" : <string>,\n \"term\" : {\n \"operator\" : \"equalValue\",\n \"field\" : \"Keywords\",\n \"values\" : [\"dog\"],\n \"subqueries\" : [\n {\"operator\" : \"startsWithValue\", ...},\n {\"operator\" : \"greaterThanValue\",...}\n ]\n }\n}\n
Response Format: The response format is dependent on a few things: \t- if async is true, then the result will be a string, specifically a job id, suitable for use with the other job facilities,
\t- if the query yields multiple assets, then the response will be a zip containing the requested originals,
- if the query yields a single asset, the server will stream it to the client directly.
","operationId":"getOriginals","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"json asset query","required":true,"schema":{"$ref":"#/components/schemas/JSONObject"}},{"name":"async","in":"query","description":"async","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Job ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobIdResponse"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/asset":{"get":{"tags":["asset"],"summary":"Query for assets","description":"Returns a list of assets from a catalog that match the terms specified in the assetQuery parameter.
The returned assets will contain the field values specified in the optional assetQueryResultOptions parameter. If assetQueryResultOptions is null, or contains no field names, then a default set of fields will be returned.
If no paging options are provided in the assetQueryResultOptions then a default pageSize of 1000 items will be assigned.","externalDocs":{"url":"http://doc.extensis.com/api/portfolio/soap_assets_AssetSEIService.html#getAssets"},"operationId":"getAssets","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Asset query and result options","content":{"application/json":{"schema":{"$ref":"#/components/schemas/assetQuery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetQueryResults"}}}},"400":{"description":"InvalidParameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["asset"],"summary":"Query for assets","description":"Returns a list of assets from a catalog that match the terms specified in the assetQuery parameter.
The returned assets will contain the field values specified in the optional assetQueryResultOptions parameter. If assetQueryResultOptions is null, or contains no field names, then a default set of fields will be returned.
If no paging options are provided in the assetQueryResultOptions then a default pageSize of 1000 items will be assigned.","externalDocs":{"url":"http://doc.extensis.com/api/portfolio/soap_assets_AssetSEIService.html#getAssets"},"operationId":"getAssetsPost","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Asset query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/assetQuery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetQueryResults"}}}},"400":{"description":"InvalidParameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["asset"],"summary":"Delete assets from catalog.","description":"Delete the assets matching the assetQuery","operationId":"removeAssets","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Asset query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/removeAssets"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAssetsResult"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/job":{"get":{"tags":["job"],"summary":"Get job ids","description":"Get all job ids for the user","operationId":"getJobIDs","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job IDs","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/job/{job_id}/_errorDetails":{"get":{"tags":["job"],"summary":"Get Error Details for Job","description":"Get Error Details for Job
Returns the details of any errors a Job might have encountered.
Each error will contain the cause of the error, and the corresponding Asset's Id or Path.
Returns null if the jobId is unknown or the user does not have access to the Job.
Response Format:[\n {\"name\": \"assetNotFound\", \"value\": \"74\"},\n {\"name\": \"assetLocked\", \"value\": \"75\"}\n]\n
","operationId":"getErrorDetailsForJob","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/job/_status":{"get":{"tags":["job"],"summary":"Retrieve a list of job statuses","description":"Returns the status of all Jobs belonging to the user.
","operationId":"getJobStatus","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobStatus"}}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/job/{job_ids}/_status":{"get":{"tags":["job"],"summary":"Retrieve a list of job statuses","description":"Returns the status of one or more specified Jobs.
A JobStatus encapsulates details such as whether a Job has completed or is in progress and the percentage complete, whether the Job has encountered any errors, etc.
Response Format:[\n {\n \"status\" : \"inProgress|cancelled|done|failed\",\n \"progress\" : \"x/y\",\n \"failureCount\" : 0,\n \"results\" : [\n \"url of result data\"\n ]\n }\n]\n
","operationId":"getJobStatus_1","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"job_ids","in":"path","description":"comma separated list of job ids","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobStatus"}}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/job/{job_ids}/_cancel":{"put":{"tags":["job"],"summary":"Cancel the specified in-progress Jobs","description":"Cancels and optionally deletes a currently queued or running Jobs.","operationId":"cancelJobs","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"job_ids","in":"path","description":"comma separated list of job ids","required":true,"schema":{"type":"string"}},{"name":"delete_jobs","in":"query","description":"delete the jobs (defaults to true)","schema":{"type":"boolean"}}],"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/report/netpublish-usage":{"get":{"tags":["report"],"operationId":"netpublishUsageReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"site_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"criteria","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/netpublish-download-frequency":{"get":{"tags":["report"],"operationId":"netpublishDownloadFrequencyReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"site_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/keyword-statistics":{"get":{"tags":["report"],"operationId":"assetCountForField","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"catalogName","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"maxRows","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/asset-most-downloaded":{"get":{"tags":["report"],"operationId":"mostDownloadedAssetReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"catalogName","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/asset-most-previewed":{"get":{"tags":["report"],"operationId":"mostPreviewedAssetReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"catalogName","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/search-terms":{"get":{"tags":["report"],"operationId":"searchTermsReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/file-types":{"get":{"tags":["report"],"operationId":"fileTypesReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"bySizeOnDisk","in":"query","schema":{"type":"boolean"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/report/asset-downloads":{"get":{"tags":["report"],"operationId":"downloadByReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/report/asset-deletions":{"get":{"tags":["report"],"operationId":"deleteByReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/report/asset-uploads":{"get":{"tags":["report"],"operationId":"assetUploadsReport","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"query","schema":{"type":"string"}},{"name":"startingDate","in":"query","schema":{"type":"string"}},{"name":"endingDate","in":"query","schema":{"type":"string"}},{"name":"locale","in":"query","schema":{"type":"string"}},{"name":"includeHeader","in":"query","schema":{"type":"boolean"}},{"name":"format","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/tab-separated-values":{}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/checkout":{"get":{"tags":["asset","catalog","versioning"],"operationId":"checkOutAsset","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/asset/{asset_id}/versions":{"get":{"tags":["asset","versioning"],"summary":"Get versions for an asset","description":"Get the list of versions for an asset","operationId":"getAssetVersionSummaries","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVersionsResponseModel"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/gallery":{"put":{"tags":["catalog","gallery"],"summary":"Update a Gallery","description":"Update a Gallery.
Request Format:{\n \"id\": \"159\",\n \"name\": \"My Updated Gallery\",\n \"owner\": \"newOwner\",\n \"type\": \"saved|smart\",\n \"accessType\": \"publicAccess|privateAccess|lockedAccess\",\n \"savedFind\": { // for smart galleries only\n \"operator\":\"equalValue\",\n \"field\":\"Keywords\",\n \"values\":[\"dog\"],\n }\n}\n
","operationId":"updateGallery","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"gallery","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Gallery"}}},"required":true},"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["catalog","gallery"],"summary":"Create a Gallery","description":"Create a Gallery.
Request Format:{\n \"name\": \"My New Gallery\",\n \"owner\": \"mSmith\",\n \"type\": \"saved|smart\",\n \"accessType\": \"publicAccess|privateAccess|lockedAccess\",\n \"savedFind\": { // for smart galleries only\n \"operator\":\"equalValue\",\n \"field\":\"Keywords\",\n \"values\":[\"dog\"],\n }\n}\n
","operationId":"createGallery","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gallery"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/gallery/{gallery_id}":{"delete":{"tags":["catalog","gallery"],"summary":"Delete a Gallery","description":"Delete a Gallery.
","operationId":"deleteGallery","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"gallery_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/gallery/{gallery_id}/_assets":{"post":{"tags":["gallery","asset"],"summary":"Add assets to a gallery","description":"The assets are specified using a standard Query object (see the docs for get assets).This could be as simple as one or more assets by id, on up to a complex multi-term query.","operationId":"addItemsToGallery","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"gallery_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"gallery","content":{"*/*":{"schema":{"$ref":"#/components/schemas/assetQuery"}}},"required":true},"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["gallery","asset"],"summary":"Remove assets from a gallery","description":"The assets are specified using a standard Query object (see the docs for get assets).This could be as simple as one or more assets by id, on up to a complex multi-term query.","operationId":"removeItemsFromGallery","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"gallery_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"gallery","content":{"*/*":{"schema":{"$ref":"#/components/schemas/assetQuery"}}},"required":true},"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}/_sync":{"post":{"tags":["catalog","watchfolder"],"summary":"Synchronize Folder","description":"Initiate an asynchronous check for any changes to a folder located at relative_path.\nThe server will update its database with any changes it finds in the folders and files on disk.\nThis is most useful for folders that are set to sync manually or on a schedule.\nrelative_path is an optional parameter, that when specified, must be a colon-delimited relative path to a subfolder.","operationId":"synchronizeFolder","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relative_path","in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}/_details":{"get":{"tags":["catalog","watchfolder"],"operationId":"getDetailsForWatchFolder","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}/subfolder":{"post":{"tags":["catalog","watchfolder"],"summary":"Create a Subfolder","description":"Create a Subfolder
Create a new subfolder under the Watch Folder at the specified location relative to the Watch Folder root.\n\nOn successful return, a new subfolder is created that resides under the Watch Folder at the relative subfolder path.\nAny parent folders specified in the relative path that do not exist under the Watch Folder will be created.\n\nFor example: If the Watch Folder is ::Server:share:images: and you wanted the new subfolder to have the path ::Server:share:images:foo:bar:subfolder, the relative path would be foo:bar:subfolder","operationId":"createSubfolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"relative path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubfolderOperationRequestModel"}}},"required":true},"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}/subfolder/_delete":{"put":{"tags":["catalog","watchfolder"],"summary":"Delete a Subfolder and its contents","description":"Delete a Subfolder and its contents
Warning: this deletes a folder on disk, and everything inside it, including files and other folders.","operationId":"deleteSubfolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"relative path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubfolderOperationRequestModel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gallery"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["catalog","watchfolder"],"summary":"Delete a Subfolder and its contents","description":"Create a Subfolder and its contents
Warning: this deletes a folder on disk, and everything inside it, including files and other folders.","operationId":"deleteSubfolderDelete","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"relative path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubfolderOperationRequestModel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gallery"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/subfolder/_move":{"post":{"tags":["catalog","watchfolder"],"summary":"Move a Subfolder","description":"Moves a subfolder to another location within the Watch Folder tree or to a different Watch Folder.
A subfolder cannot be moved between catalogs, nor to any of its own children.\n\nRequest Format:{\n \"watchFolderIdSource\" : \"2\",\n \"watchFolderIdDestination\" : \"5\",\n \"relativePathSource\" : \"path:to:source:folder\",\n \"relativePathDestination\" : \"path:to:destination:folder\",\n}\n
","operationId":"moveSubfolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"relative path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveSubfolderRequestModel"}}},"required":true},"responses":{"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/upload":{"post":{"tags":["asset","catalog"],"operationId":"uploadFile","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"path":{"type":"string"},"file":{"$ref":"#/components/schemas/FormDataContentDisposition"},"ingestFields":{"$ref":"#/components/schemas/JSONArray"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}/upload":{"post":{"tags":["asset","catalog","watchfolder"],"operationId":"uploadFileForWatchfolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"path":{"type":"string"},"file":{"$ref":"#/components/schemas/FormDataContentDisposition"},"filename":{"type":"string"},"ingestFields":{"$ref":"#/components/schemas/JSONArray"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/videoExtensions":{"get":{"tags":["global"],"summary":"Get video file extensions","description":"List the file extensions that indicate video files","operationId":"getVideoExtensions","responses":{"default":{"content":{"application/json":{"schema":{"type":"array","example":["mp4","mov"]}}}}}}},"/v1/audioExtensions":{"get":{"tags":["global"],"summary":"Get audio file extensions","description":"List the file extensions that indicate audio files","operationId":"getAudioExtensions","responses":{"default":{"content":{"application/json":{"schema":{"type":"array","example":["aac","mp3"]}}}}}}},"/v1/catalog/{catalog_id}/taskPreset":{"get":{"tags":["catalog","image conversion"],"operationId":"getTaskPresets","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONArray"}}}}}}},"/v1/branding-settings":{"get":{"tags":["global"],"summary":"Get the custom login settings","description":"Get the custom login settings","operationId":"getBrandingSettings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingSettingsResponseModel"}}}}}}},"/v1/catalog/{catalogId}/field-definition/{fieldDefinitionId}/nested-value":{"post":{"tags":["catalog","field"],"operationId":"addNestedPredefinedValues","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"parentId","in":"query","schema":{"type":"string"}},{"name":"fieldDefinitionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NestedValue"}}}}}}},"delete":{"tags":["catalog","field"],"operationId":"deleteNestedPredefinedValues","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldDefinitionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ids","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v1/catalog/{catalogId}/field-definition/{fieldDefinitionId}/predefined-value":{"post":{"tags":["catalog","field"],"operationId":"addOrRemovePredefinedValues","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldDefinitionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/audit/asset/assetDeletions":{"get":{"tags":["audit"],"summary":"Get asset deletion records","description":"Get asset deletion records since specified date for specified catalog.","operationId":"getAssetDeletions","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalogId","in":"query","schema":{"type":"string"}},{"name":"sinceDate","in":"query","description":"number of seconds since Jan. 1, 1970","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of asset deletions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetDeletionModel"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"InsufficientPrivileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/auth/public-key":{"get":{"tags":["authentication"],"summary":"Retrieve the public key for hashing passwords when logging in","description":"Provides the necessary RSA public key information to properly encrypt passwords for authentication against Portfolio.","operationId":"getRSAPublicKey","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicKeyResponse"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder":{"get":{"tags":["watchfolder"],"summary":"Retrieve the Watch Folders for the given catalog","description":"Retrieve the top-level Watch Folders for the given catalog.Special data values:\n| Description | Value |
\n| Legacy sync manual | -1 |
\n| Legacy start time ignore | -1 |
\n| Legacy sync on changes found | -2 |
\n
","operationId":"getWatchFolders","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WatchFolder"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["catalog","watchfolder"],"operationId":"addWatchFolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"createFolderOnDisk","in":"query","description":"createFolderOnDisk","required":true,"schema":{"type":"boolean"}},{"name":"combineChildFolders","in":"query","description":"combineChildFolders","required":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"watchfolder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}}}}}},"/v1/catalog/{catalog_id}/watchfolder/{watchfolder_id}":{"get":{"tags":["watchfolder"],"summary":"Retrieve the folder tree for the specified Watch Folder","description":"Get the entire folder tree of the specified Watch Folder.\n
Sample Response Format:{\n\t\"n\":\"::computer:Macintosh HD:My-Watch-Folder:\",\n\t\"f\":0,\n\t\"m\":0,\n\t\"s\":[\n\t\t{\n\t\t\t\"n\":\"animals\",\n\t\t\t\"f\":0,\t\n\t\t\t\"m\":0,\n\t\t\t\"s\":[\n\t\t\t\t{\n\t\t\t\t\t\"n\":\"cats\",\n\t\t\t\t\t\"f\":0,\n\t\t\t\t\t\"m\":0,\n\t\t\t\t\t\"s\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"n\":\"Persians\",\n\t\t\t\t\t\t\t\"f\":0,\n\t\t\t\t\t\t\t\"m\":0\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"n\":\"minerals\",\n\t\t\t\"f\":0,\n\t\t\t\"m\":0,\n\t\t\t\"s\":[\n\t\t\t\t{\n\t\t\t\t\t\"n\":\"agates\",\n\t\t\t\t\t\"f\":0,\n\t\t\t\t\t\"m\":0\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"changeNumber\":9\n}
The following data will be returned per folder:\n| Field Name | Description |
\n| n | Folder Name |
\n| s | Subfolders |
\n| f | Flags (see values below) |
\n| m | Folder Tree Flags (includes flags for all subfolders ORed with this folder's flags, see values below) |
\n
\n
The flags contain the following data:\n| Flag Value | Flag Description |
\n| 1 | Out of Sync |
\n| 2 | Scanning |
\n| 4 | Unavailable |
\n| 8 | Error |
\n| 16 | Contains Excluded Files |
\n| 32 | Contains Files Missing on Disk |
\n| 64 | Contains Modified Files |
\n
","operationId":"getFolderTreeForWatchFolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"tags":["catalog","watchfolder"],"operationId":"updateWatchFolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"watchfolder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONObject"}}},"required":true},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}},"delete":{"tags":["catalog","watchfolder"],"operationId":"removeWatchFolder","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}},{"name":"watchfolder_id","in":"path","description":"watchfolder id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v1/catalog/{catalog_id}/galleries":{"get":{"tags":["catalog","gallery"],"summary":"Retrieve the galleries for the specified catalog","description":"Retrieves a list of all galleries for the specified catalog for which the currently logged in user has access/visibility.
Sample Response Format:[\n\t{\n\t\t\"id\":\"1\",\n\t\t\"name\":\"Gallery 1\",\n\t\t\"type\":\"saved\",\n\t\t\"owner\":\"asmith\",\n\t\t\"accessType\":\"publicAccess\"\n\t},\n\t{\n\t\t\"id\":\"2\",\n\t\t\"name\":\"Gallery 2\",\n\t\t\"type\":\"saved\",\n\t\t\"owner\":\"asmith\",\n\t\t\"accessType\":\"privateAccess\"\n\t},\n\t{\t\n\t\t\"id\":\"3\",\n\t\t\"name\":\"Smart Gallery\",\n\t\t\"type\":\"smart\",\n\t\t\"owner\":\"asmith\",\n\t\t\"accessType\":\"publicAccess\",\n\t\t\"savedFind\": {\n\t\t\t\"operator\":\"containsValue\",\n\t\t\t\"field\":\"Keywords\",\n\t\t\t\"values\":[\"foo\"]\n\t\t}\n\t},\n\t...\n]
","operationId":"getGalleries","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Gallery"}}}}},"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["catalog","gallery"],"operationId":"getGalleriesPost","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONArray"}}}}}}},"/v1/catalog/{catalog_id}/asset/updateFieldValues":{"post":{"tags":["asset","catalog"],"summary":"Update asset field values","description":"Add, remove, append, or replace field values in a collection of assets described by a query, and optionally embed the changes in original files.
For code examples and more notes, see http://doc.extensis.com/api/portfolio/soap_assets_AssetSEIService.html#updateAssetFieldValues
Request Format:{\n \"embed\" : true|false,\n \"query\" : {\n \"galleryId\" : <string>,\n \"term\" : {\n \"operator\" : \"equalValue\",\n \"field\" : \"Keywords\",\n \"values\" : [\"dog\"],\n \"subqueries\" : [\n {\"operator\" : \"startsWithValue\", ...},\n {\"operator\" : \"greaterThanValue\",...}\n ]\n }\n },\n \"changes\" : [\n {\"action\" : \"add\", \"field\":\"Keywords\",\"existingValues\":null,\"newValues\":[\"egg\"]}\n ]\n}
","operationId":"updateAssetFieldValues","parameters":[{"name":"session","in":"query","description":"session id","required":true,"schema":{"type":"string"}},{"name":"catalog_id","in":"path","description":"catalog id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update field values request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetFieldValuesRequestModel"}}},"required":true},"responses":{"401":{"description":"InvalidCredentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ItemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/catalog/{catalog_id}/unlock":{"post":{"tags":["asset","catalog"],"summary":"Unlock the specified assets","description":"Unlock the specified assets.
Note that only Vault-based Catalogs support locking.
Assets are specified by an array of asset IDs.
Request Format:{\"values\": [142, 147, 289]}
Response Format:{\"failures]\":{\"147\":\"NOT_FOUND\"}}
Any assets that cannot be unlocked will be identified by their ID and one of the following in the response:\n| Error code |
\n| ASSET_CHECKED_OUT |
\n| ASSET_NOT_LOCKED |
\n| NOT_FOUND |
\n| UNEXPECTED_ERROR |
\n
","operationId":"unlock","parameters":[{"name":"session","in":"query","schema":{"type":"string"}},{"name":"catalog_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Asset ids to lock","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockAssetsRequestModel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockAssetsResponseModel"}}}},"400":{"description":"InvalidParameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"LicenseCountExceeded, UnexpectedError, OperationTimedOut","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"Task":{"required":["taskId"],"type":"object","properties":{"name":{"type":"string"},"catalogId":{"type":"string"},"taskId":{"type":"string"},"type":{"type":"string","enum":["convert","rename","saveOnDisk","download","regenerateThumbnail","updateAssetProperties","moveAssets","copyAssets","exportAssets","contactSheet","importData","ingestAssets","updatePath","exportData","lock","unlock","addSuggestedKeywords","cleanUpVault","fixContentVersions","runScript","computeGeoSearchFields"]},"settings":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"settingsByName":{"type":"object","additionalProperties":{"type":"string"}}}},"FieldValuesChange":{"type":"object","properties":{"fieldName":{"type":"string"},"action":{"type":"string","enum":["add","replaceAllValues","replace","append","delete","deleteAllValues"]},"existingValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"MoveSubfolderRequestModel":{"type":"object","properties":{"relativePathSource":{"type":"string"},"relativePathDestination":{"type":"string"},"watchFolderIdSource":{"type":"string"},"watchFolderIdDestination":{"type":"string"}}},"Attribute":{"type":"object","properties":{"name":{"type":"string","xml":{"attribute":true}},"value":{"type":"string"}}},"FieldDefinition":{"type":"object","properties":{"systemName":{"type":"string"},"internalName":{"type":"string"},"localizedNames":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"type":{"type":"integer","format":"int32"},"hasPredefinedValues":{"type":"boolean"},"predefinedValues":{"type":"array","items":{"type":"string"}},"nestedPredefinedValues":{"type":"array","items":{"$ref":"#/components/schemas/NestedValue"}},"usePredefinedOnly":{"type":"boolean"},"maxLength":{"type":"integer","format":"int32"},"precision":{"type":"integer","format":"int32"},"defaultValues":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"multivalued":{"type":"boolean"},"sortable":{"type":"boolean"},"searchable":{"type":"boolean"},"systemField":{"type":"boolean"},"hierarchical":{"type":"boolean"},"embeddable":{"type":"boolean"},"extractable":{"type":"boolean"},"allValueStringsForNestedPredefinedValues":{"type":"array","items":{"type":"string"}},"showTime":{"type":"boolean"}}},"JobIdResponse":{"type":"object","properties":{"jobId":{"type":"string"}}},"LocalizableMessage":{"type":"object","properties":{"messageId":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"NestedValue":{"type":"object","properties":{"parentId":{"type":"string"},"value":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/NestedValue"}},"id":{"type":"string"}}},"LoginRequest":{"type":"object","properties":{"userName":{"type":"string"},"encryptedPassword":{"type":"string"}}},"ApiVersionResponseModel":{"type":"object","properties":{"Server API":{"type":"string","example":"1.0"}}},"Folder":{"type":"object","properties":{"name":{"type":"string","xml":{"name":"n","attribute":true}},"subfolders":{"type":"array","xml":{"name":"s"},"items":{"$ref":"#/components/schemas/Folder"}},"flags":{"type":"integer","format":"int32","xml":{"name":"f"}},"folderFlags":{"type":"integer","format":"int32","xml":{"name":"m"}},"changeNumber":{"type":"integer","format":"int64"}}},"RunJobRequestModel":{"type":"object","properties":{"assetQuery":{"$ref":"#/components/schemas/assetQuery"},"job":{"$ref":"#/components/schemas/Job"}}},"MultiValuedAttribute":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"SubfolderOperationRequestModel":{"type":"object","properties":{"relativePath":{"type":"string"}}},"JobStatus":{"type":"object","properties":{"jobId":{"type":"string"},"catalogId":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["retrieving","queued","inProgress","complete","canceled"]},"timeSubmitted":{"type":"string"},"timeCompleted":{"type":"string"},"jobDetails":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"assetData":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}}},"BrandingSettingsResponseModel":{"type":"object","properties":{"useCustomBranding":{"type":"boolean","example":true},"useCustomImage":{"type":"boolean","example":true},"customImageFilename":{"type":"string","example":"image.jpg"},"customTitle":{"type":"string","example":"Portfolio Web"},"customURL":{"type":"string","example":"https://www.extensis.com"},"customBackgroundColor":{"type":"string","example":"009900"}}},"WatchFolder":{"type":"object","properties":{"watchFolderId":{"type":"string"},"path":{"type":"string"},"scanContinuouslyForChanges":{"type":"boolean"},"synchronize":{"type":"string","enum":["manual","whenChangesAreFound","onSchedule","atSpecificTime"]},"syncFrequencyInSeconds":{"type":"integer","format":"int32"},"syncStartTimeInSecondsFromMidnight":{"type":"integer","format":"int32"},"removeMissingItems":{"type":"boolean"},"catalogingOptionsId":{"type":"string"},"currentStatus":{"type":"integer","format":"int32"}}},"PublicKeyResponse":{"type":"object","properties":{"modulusBase16":{"type":"string"},"exponent":{"type":"string"}}},"UpdateAssetFieldValuesRequestModel":{"type":"object","properties":{"embed":{"type":"boolean"},"changes":{"type":"array","items":{"$ref":"#/components/schemas/FieldValuesChange"}},"assetQuery":{"$ref":"#/components/schemas/assetQuery"}}},"assetQuery":{"type":"object","properties":{"galleryId":{"type":"string","description":"A optional gallery ID to search within","nullable":true,"example":"379"},"term":{"$ref":"#/components/schemas/assetQueryTerm"},"pageSize":{"type":"integer","format":"int32","example":20},"startingIndex":{"type":"integer","format":"int32","example":0},"fields":{"type":"array","description":"Metadata fields to return","example":["Filename","File Size"],"items":{"type":"string","description":"Metadata fields to return","example":"[\"Filename\",\"File Size\"]"}},"sortOptions":{"$ref":"#/components/schemas/sortOptions"}}},"GetVersionsResponseModel":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AssetVersionSummary"}}}},"Asset":{"type":"object","properties":{"assetId":{"type":"string"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/MultiValuedAttribute"}},"locked":{"type":"boolean"}}},"Job":{"type":"object","properties":{"jobId":{"type":"string"},"description":{"type":"string"},"sourceImage":{"type":"string","enum":["original","preview"]},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"clientLocale":{"type":"string","enum":["en_US","en_GB","es_ES","de_DE","fr_FR","it_IT","ja_JP"]},"clientTimeZoneOffset":{"type":"integer","format":"int32"},"completionSemaphore":{"type":"object","properties":{"fair":{"type":"boolean"},"queueLength":{"type":"integer","format":"int32"}}},"destinationTask":{"$ref":"#/components/schemas/Task"}}},"AssetQueryTerm":{"required":["fieldName","operator"],"type":"object","properties":{"operator":{"type":"string","enum":["operatorAnd","operatorOr","assetsById","assetsNotHavingId","notNullValue","nullValue","equalValue","notEqualValue","containsValue","startsWithValue","endsWithValue","notContainsValue","notStartsWithValue","notEndsWithValue","lessThanValue","greaterThanValue","lessThanOrEqualValue","greaterThanOrEqualValue","inFuture","inPast","inNextDays","inPreviousDays","today","thisMonth","thisYear","valueCountEquals","valueCountGreaterThan","valueCountLessThan","matchUnparsedQueryString","intersectsGeometry"]},"fieldName":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"subqueries":{"type":"array","items":{"$ref":"#/components/schemas/AssetQueryTerm"}}}},"LockAssetsResponseModel":{"type":"object","properties":{"failures":{"type":"object","additionalProperties":{"type":"object"}}}},"RemoveAssetsResult":{"type":"object","properties":{"numberOfLockedAssetsNotRemoved":{"type":"integer","format":"int32"}}},"LoginResponse":{"type":"object","properties":{"session":{"type":"string"}}},"RemoveAssetsQuery":{"type":"object","properties":{"galleryId":{"type":"string","description":"A optional gallery ID to search within","nullable":true,"example":"379"},"term":{"$ref":"#/components/schemas/assetQueryTerm"}}},"AssetQueryResults":{"type":"object","properties":{"totalNumberOfAssets":{"type":"integer","format":"int32"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"totalNumberOfClusteredAssets":{"type":"integer","format":"int32"}}},"JSONArray":{"type":"object"},"Cluster":{"type":"object","properties":{"geohash":{"type":"string"},"count":{"type":"integer","format":"int32"},"west":{"type":"number","format":"double"},"north":{"type":"number","format":"double"},"east":{"type":"number","format":"double"},"south":{"type":"number","format":"double"}}},"AssetDeletionModel":{"type":"object","properties":{"filename":{"type":"string","example":"image.jpg"},"asset_id":{"type":"string","example":"402993"},"timestamp":{"type":"string","example":"2018-08-01T20:00:36.629Z"}}},"Catalog":{"type":"object","properties":{"name":{"type":"string"},"wereUsersImported":{"type":"boolean"},"catalogId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"ErrorResponse":{"type":"object","properties":{"faultCode":{"type":"string"},"message":{"type":"string"}}},"LockAssetsRequestModel":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"JSONObject":{"type":"object","properties":{"escapeForwardSlashAlways":{"type":"boolean"}}},"AssetVersionSummary":{"type":"object","properties":{"versionId":{"type":"string"},"cause":{"type":"string","enum":["cataloged","checkin","copied","edited","interimEdit"]},"contentId":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"userShortName":{"type":"string"},"comment":{"type":"string"},"editedFields":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"sortOptions":{"type":"object","properties":{"field":{"type":"string","example":"Cataloged"},"order":{"type":"string","nullable":true,"example":"asc","enum":["asc","desc"]}}},"assetQueryTerm":{"type":"object","properties":{"operator":{"type":"string","example":"equalValue","enum":["operatorAnd","operatorOr","assetsById","assetsNotHavingId","notNullValue","nullValue","equalValue","notEqualValue","containsValue","startsWithValue","endsWithValue","notContainsValue","notStartsWithValue","notEndsWithValue","lessThanValue","greaterThanValue","lessThanOrEqualValue","greaterThanOrEqualValue","inFuture","inPast","inNextDays","inPreviousDays","today","thisMonth","thisYear","valueCountEquals","valueCountGreaterThan","valueCountLessThan","matchUnparsedQueryString","intersectsGeometry"]},"field":{"type":"string","example":"Keywords"},"values":{"type":"array","example":["dog"],"items":{"type":"string","example":"[\"dog\"]"}},"subqueries":{"type":"array","example":[],"items":{"$ref":"#/components/schemas/assetQueryTerm"}}}},"Gallery":{"required":["savedFind"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["saved","smart"]},"owner":{"type":"string"},"galleryId":{"type":"string"},"savedFind":{"$ref":"#/components/schemas/AssetQueryTerm"},"accessType":{"type":"string","enum":["publicAccess","privateAccess","lockedAccess"]},"public":{"type":"boolean"},"private":{"type":"boolean"},"locked":{"type":"boolean"}}},"FormDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"removeAssets":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/RemoveAssetsQuery"}}}}}}