From 3c02db3bdeba600dfccaee1c2305944115f8b034 Mon Sep 17 00:00:00 2001 From: quin-build-test Date: Wed, 18 Dec 2024 14:16:28 +0000 Subject: [PATCH] updating API Documentation release (version 95_CF224) --- dam-api/openapi.json | 2 +- image-processor-api/openapi.json | 2 +- pzn-api/openapi.json | 26 +-- ring-api/openapi.json | 2 +- search-v2-api/openapi.json | 299 ++++++++++++++----------------- wcm-api/openapi.json | 238 ++++++++++++++++++++++++ 6 files changed, 388 insertions(+), 181 deletions(-) diff --git a/dam-api/openapi.json b/dam-api/openapi.json index fbb5a1c..799d645 100644 --- a/dam-api/openapi.json +++ b/dam-api/openapi.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Digital Asset Management API","version":"1.35.0","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management features of HCL DX 9.5","contact":{}},"paths":{"/api-version":{"get":{"x-controller-name":"ApiVersionController","x-operation-name":"findVersion","tags":["ApiVersionController"],"security":[{"cookieAuth":[]}],"description":"This will retrieve the API versions.","responses":{"200":{"description":"Array of api version.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersionResponseDto"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"ApiVersionController.findVersion"}},"/collections/{collection_id}/items/{item_id}/references":{"get":{"x-controller-name":"CollectionController","x-operation-name":"getMediaReferences","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"View reference details of media assets.","responses":{"200":{"description":"Array of media asset items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetReferencesResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records."},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."}],"operationId":"CollectionController.getMediaReferences"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}/versions/{version_id}":{"get":{"x-controller-name":"RenditionController","x-operation-name":"getVersionById","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve version data as per the provided version id.","responses":{"200":{"description":"Retrieve versions list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionPayloadDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"version_id","in":"path","schema":{"type":"string"},"description":"Provide the version ID. e.g., 0j06cc1c-bb99-48b3-b8ff-4e5de51b4b59 or version number. e.g., 1.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true).","required":false},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"RenditionController.getVersionById"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}/versions":{"get":{"x-controller-name":"RenditionController","x-operation-name":"getVersions","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve versions list as per the provided rendition id.","responses":{"200":{"description":"Retrieve versions list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionListResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records (e.g. 'created', 'updated', 'version', 'createdBy', 'updatedBy') "},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."}],"operationId":"RenditionController.getVersions"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}":{"put":{"x-controller-name":"RenditionController","x-operation-name":"replaceRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will create new version for the provided rendition id.","responses":{"200":{"description":"Updates rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"description":{"type":"string"},"actions":{"type":"object"},"removeExistingKeywords":{"type":"boolean"},"addNewKeywords":{"type":"boolean"},"customUrl":{"type":"string"},"id":{"type":"string"},"version":{"type":"string"},"mediaStorageId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"metadata":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":4},"operationId":"RenditionController.replaceRendition"},"patch":{"x-controller-name":"RenditionController","x-operation-name":"updateRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will update the part of the rendition.","responses":{"200":{"description":"Retrieves the updated rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"customUrl":{"type":"string"},"updatedBy":{"type":"string"},"updated":{"type":"string"},"mediaStorageId":{"type":"string"},"id":{"type":"string"},"version":{"type":"string"},"createdBy":{"type":"string"},"created":{"type":"string"},"metadata":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":4},"operationId":"RenditionController.updateRendition"},"get":{"x-controller-name":"RenditionController","x-operation-name":"getRenditionById","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API retrieves rendition data as per the provided rendition id.","responses":{"200":{"description":"Retrieve renditions data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"thumbnail","in":"query","schema":{"type":"boolean"},"description":"To get thumbnail data, set as true or false (e.g. true)."},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true)."},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"RenditionController.getRenditionById"}},"/collections/{collection_id}/items/{item_id}/renditions":{"post":{"x-controller-name":"RenditionController","x-operation-name":"createRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API wil create new rendition.","responses":{"200":{"description":"Creates rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"id":{"type":"string"},"mediaItemId":{"type":"string"},"renditionType":{"type":"string"},"thumbnailMediaStorageId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"file":{"type":"string","format":"binary"},"customUrl":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"RenditionController.createRendition"},"get":{"x-controller-name":"RenditionController","x-operation-name":"getRenditions","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve renditions list as per the provided item id.","responses":{"200":{"description":"Retrieve rendition list.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RenditionListResponse"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true).","required":false},{"name":"fileName","in":"query","schema":{"type":"string"},"description":"Provide the download file name. (default: download)","required":false},{"name":"downloadType","in":"query","schema":{"type":"string","enum":["rendition","original","all"],"example":"all"},"description":"Provide the download type. (e.g. 'all', 'original', 'rendition')","required":false}],"operationId":"RenditionController.getRenditions"}},"/collections/{collection_id}/items/{item_id}":{"put":{"x-controller-name":"CollectionController","x-operation-name":"replaceMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This API will replace item for provided item id.","responses":{"200":{"description":"Successful response on updating media asset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"collectionIds":{"type":"array","items":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"resetKeywords":{"type":"boolean","items":{"type":"boolean"},"description":"Delete existing keywords and triggers supplemental stack"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"CollectionController.replaceMediaItem"},"patch":{"x-controller-name":"CollectionController","x-operation-name":"updateMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Replaces part of item.","responses":{"200":{"description":"Updated media asset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference check for the Media Asset"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"collectionIds":{"type":"array","items":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords."},"name":{"type":"string","items":{"type":"string"},"description":"Specifies the name."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"resetKeywords":{"type":"boolean","items":{"type":"boolean"},"description":"Delete existing keywords and triggers supplemental stack"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the asset has to be moved"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"CollectionController.updateMediaItem"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getMediaByIdFromCollection","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve information on the media asset. Also it can retrieve thumbnail or binary data.","responses":{"200":{"description":"Information on the media asset or thumbnail or binary data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemsResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"thumbnail","in":"query","schema":{"type":"boolean"}},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"CollectionController.getMediaByIdFromCollection"},"delete":{"x-controller-name":"CollectionController","x-operation-name":"deleteMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Delete a media asset from the specified collection.","responses":{"204":{"description":"Media asset DELETE success."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the Media Asset."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"405":{"description":"Returns if the Media Asset is referenced and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference check for the Media Asset"}],"operationId":"CollectionController.deleteMediaItem"}},"/collections/{collection_id}/items":{"post":{"x-controller-name":"CollectionController","x-operation-name":"createMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This API will create a new item.","responses":{"200":{"description":"Successful response on creating item.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"name":{"type":"string","description":"Specifies the media asset name.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media item were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"title":{"type":"string","description":"Media asset file title.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"string","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"string","description":"Specifies the size.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"string","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaTypeId":{"type":"string","description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailFileSize":{"type":"string","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":2},"operationId":"CollectionController.createMediaItem"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getItemsByCollectionId","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve media assets/collections inside collection based on the type with filter criteria.","responses":{"200":{"description":"Array of media assets/collections under collection retrieved based on the type with filter criteria.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MediaItemsResponse"},{"$ref":"#/components/schemas/CollectionListResponseDto"}]},"example":{"offset":0,"limit":0,"total":0,"self":"string","first":"string","prev":"string","next":"string","last":"string","paths":[{"name":"string","id":"string"}],"contents":[{"id":"string","name":"string","description":"string","userid":"string","parentid":"string","rootparentid":"string","accessreferenceid":"string","created":"2020-07-13T12:14:34.056Z","updated":"2020-07-13T12:14:34.056Z","self":"string","total":{"videos":"string","images":"string","documents":"string","collections":"string","items":"string"},"thumbnails":[{"mediaName":"string","mimeType":"string","self":"string"}],"editable":true,"deletable":true,"accessible":true,"rootaccessreferenceid":"string"}]}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"filterAccess","in":"query","schema":{"type":"string"},"description":"Provide the access way either READ or WRITE."},{"name":"type","in":"query","schema":{"type":"string","enum":["item","collection"],"default":"item","example":"item"},"description":"Specifies the result set to return (collections or items) under a collection."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records.
This filter will be applied only for type=item"},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC.
This filter will be applied only for type=item"},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}},{"name":"isFavorite","in":"query","schema":{"type":"boolean"},"description":"Provide the isFavorites value to filter the favorite records (e.g true).
This filter will be applied only for type=item"},{"name":"fileType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."}}},{"name":"minFileSize","in":"query","schema":{"type":"number"},"description":"Provide the minimum size in bytes to filter media items. (e.g. 0, 10)"},{"name":"maxFileSize","in":"query","schema":{"type":"number"},"description":"Provide the maximum size in bytes to filter media items. (e.g. 100, 1000)"}],"operationId":"CollectionController.getItemsByCollectionId"}},"/collections/{collection_id}":{"put":{"x-controller-name":"CollectionController","x-operation-name":"replaceById","tags":["CollectionController"],"description":"Replaces full collection.","security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Returns updated collection information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReq"}}},"x-parameter-index":2},"operationId":"CollectionController.replaceById"},"patch":{"x-controller-name":"CollectionController","x-operation-name":"updateById","tags":["CollectionController"],"description":"Updates part of the collection.","security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Collection PATCH success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReqPartial"}}},"x-parameter-index":2},"operationId":"CollectionController.updateById"},"get":{"x-controller-name":"CollectionController","x-operation-name":"findById","tags":["CollectionController"],"description":"This GET operation retrieves the Digital Asset Management collection.","responses":{"200":{"description":"Returns an object containing collection information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"operationId":"CollectionController.findById"},"delete":{"x-controller-name":"CollectionController","x-operation-name":"deleteCollectionById","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes media asset collection.","responses":{"204":{"description":"Successfully deletes the collection."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the Collection."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"405":{"description":"Returns if the Media Assets inside the collection are referenced, and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference Check for the Media Assets in side the Collection."}],"operationId":"CollectionController.deleteCollectionById"}},"/collections":{"post":{"x-controller-name":"CollectionController","x-operation-name":"create","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a new media asset collection.","responses":{"200":{"description":"Returns the details of a newly created collection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReq"}}},"description":"This POST operation creates a new media asset collection.","x-parameter-index":1},"operationId":"CollectionController.create"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getCollections","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve the Digital Asset Management collections based on the filter criteria.","responses":{"200":{"description":"Array of Digital Asset Management collections retrieved based on the filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionListResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string"},"description":"Provide the access way either READ or WRITE."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"query","in":"query","schema":{"type":"string"},"description":"Provide the keyword to perform search (e.g digital)."},{"name":"searchType","in":"query","schema":{"type":"string"},"description":"Provide the search type using any of [ all, name, description ]."},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}}],"operationId":"CollectionController.getCollections"}},"/eventlogs":{"post":{"x-controller-name":"SubscriberInterfaceController","x-operation-name":"createEvent","tags":["SubscriberInterfaceController"],"security":[{"cookieAuth":[]}],"description":"This API will create operation job for the given event list.
Note: This API will be an interface between a publisher and a subscriber for staging. Only admins will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Created operation job successfully.
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberInterfaceResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberInterfaceReq"}}}},"description":"Provide the event list.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","x-parameter-index":1},"operationId":"SubscriberInterfaceController.createEvent"}},"/favorites":{"post":{"x-controller-name":"FavoriteController","x-operation-name":"create","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will mark media asset as favorite.","responses":{"200":{"description":"Array of marked favorite media asset.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FavoriteRsp"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FavoriteReq"}}},"x-parameter-index":1},"operationId":"FavoriteController.create"},"get":{"x-controller-name":"FavoriteController","x-operation-name":"find","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve all the favorite media asset items.","responses":{"200":{"description":"Array of favorite media asset Items.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Favorite"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"itemId","in":"query","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}],"operationId":"FavoriteController.find"},"delete":{"x-controller-name":"FavoriteController","x-operation-name":"delete","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will unmark media asset item as favorite.","responses":{"200":{"description":"Array of unmarked favorite media asset Items.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FavoriteRsp"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FavoriteReq"}}},"x-parameter-index":1},"operationId":"FavoriteController.delete"}},"/mediaitems":{"get":{"x-controller-name":"MediaItemsController","x-operation-name":"search","tags":["MediaItemsController"],"security":[{"cookieAuth":[]}],"description":"The API provides the possibility to search for Digital Asset Management items via search query on the existing meta-data fields using such criteria as name, mime-type, title, keywords, description.","responses":{"200":{"description":"Array of filtered media asset items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemsResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collectionId","in":"query","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},{"name":"query","in":"query","schema":{"type":"string"},"description":"Provide the keyword to perform search (e.g digital)."},{"name":"searchType","in":"query","schema":{"type":"string"},"description":"Provide the search type using any of [ all, name, description ]."},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}},{"name":"fileType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."}}},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records."},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."},{"name":"isFavorite","in":"query","schema":{"type":"boolean"},"description":"Provide the isFavorites value to filter the favorite records (e.g true)."},{"name":"minFileSize","in":"query","schema":{"type":"number"},"description":"Provide the minimum size in bytes to filter media items. (e.g. 0, 10)"},{"name":"maxFileSize","in":"query","schema":{"type":"number"},"description":"Provide the maximum size in bytes to filter media items. (e.g. 100, 1000)"}],"operationId":"MediaItemsController.search"}},"/mediatypegroups/{mediatypegroup_id}":{"put":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"replaceById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Replaces full media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns updated media asset type group information in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}},"x-parameter-index":2},"operationId":"MediaTypeGroupController.replaceById"},"patch":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"updateById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Updates part of the media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns updated media asset type group information in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReqPartial"}}},"x-parameter-index":2},"operationId":"MediaTypeGroupController.updateById"},"get":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"findById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Retrieve the media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns the details of the media asset type group in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"operationId":"MediaTypeGroupController.findById"},"delete":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"deleteById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Deletes a media asset type group and removes all related media asset types which belonged to this media asset type group in Digital Asset Management.","responses":{"204":{"description":"Media assetType Group DELETE success."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"operationId":"MediaTypeGroupController.deleteById"}},"/mediatypegroups":{"post":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"create","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Creates a new media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns the details of newly created media asset type group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}},"x-parameter-index":1},"operationId":"MediaTypeGroupController.create"},"get":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"findAll","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Retrieve all media asset type groups in Digital Asset Management.","responses":{"200":{"description":"Returns all the media asset type groups in Digital Asset Management.","content":{"application/json":{"schema":{"type":"array","$ref":"#/components/schemas/MediaTypeGroupResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"MediaTypeGroupController.findAll"}},"/mediatypes/{mediatype_id}":{"put":{"x-controller-name":"MediaTypeController","x-operation-name":"replaceById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This PUT operation replaces full Digital Asset Management media asset type.","responses":{"200":{"description":"Returns updated media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeReq"}}},"x-parameter-index":2},"operationId":"MediaTypeController.replaceById"},"patch":{"x-controller-name":"MediaTypeController","x-operation-name":"updateById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This PATCH operation updates part of the Digital Asset Management media asset type.","responses":{"200":{"description":"Returns updated media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeReqPartial"}}},"x-parameter-index":2},"operationId":"MediaTypeController.updateById"},"get":{"x-controller-name":"MediaTypeController","x-operation-name":"findById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This GET operation retrieve the Digital Asset Management media asset type.","responses":{"200":{"description":"Returns an object containing media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"operationId":"MediaTypeController.findById"},"delete":{"x-controller-name":"MediaTypeController","x-operation-name":"deleteById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes a new Digital Asset Management media asset type.","responses":{"204":{"description":"Successfully deletes the media asset type."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"operationId":"MediaTypeController.deleteById"}},"/mediatypes":{"post":{"x-controller-name":"MediaTypeController","x-operation-name":"createAll","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a list of new Digital Asset Management media asset types.","responses":{"200":{"description":"Returns the details of newly created media asset types.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeDto"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeReq"}}}},"description":"Returns the details of newly created media asset types.","x-parameter-index":1},"operationId":"MediaTypeController.createAll"},"get":{"x-controller-name":"MediaTypeController","x-operation-name":"findAll","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This GET operation retrieve all the media asset types.","responses":{"200":{"description":"Returns all the media asset types available in the Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypesResponse"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"MediaTypeController.findAll"}},"/operations/{operation_id}":{"post":{"x-controller-name":"OperationController","x-operation-name":"processCallback","tags":["OperationController"],"description":"This API will perform post callback operation","responses":{"200":{"description":"Successful response for generating renditions and thumbnails"},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"operation_id","in":"path","schema":{"type":"string"},"description":"Provide the operation id (Base64 Encoded)","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"downloadURL":{"type":"string"},"error":{"type":"object"},"metadata":{"type":"string","description":"metadata should follow the object `{height: number, width: number, expiryDate: string, alternateText: string, embeddedMetadata: any}`"},"keywords":{"type":"string","description":"keywords should follow the array of object `[{keyword: string, confidencePercentage: string}]`"},"partnerId":{"type":"string"},"entryId":{"type":"string"},"status":{"type":"string"},"delete":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","x-parameter-index":1},"operationId":"OperationController.processCallback"},"get":{"x-controller-name":"OperationController","x-operation-name":"findById","tags":["OperationController"],"security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Operation model instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"operation_id","in":"path","schema":{"type":"string"},"required":true}],"operationId":"OperationController.findById"}},"/operations":{"get":{"x-controller-name":"OperationController","x-operation-name":"find","tags":["OperationController"],"security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Array of Operation model instances","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"status","in":"query","schema":{"type":"string"},"description":"Status of operation (eg \"TODO\", \"PROCESSING\", \"SUCCESS\", \"ABORT\", \"FAILED\", \"READ\", \"RETRY\", \"WAIT\", \"PENDING\")."},{"name":"triggerFunctions","in":"query","schema":{"type":"string"},"description":"Trigger function of operation."}],"operationId":"OperationController.find"}},"/reindex":{"post":{"x-controller-name":"SearchIndexingController","x-operation-name":"initiateReindexing","tags":["SearchIndexingController"],"security":[{"cookieAuth":[]}],"description":"OPENAPI_SEARCH_REINDEXING_POST_RESPONSE","responses":{"200":{"description":"This API will initiate content-source reindexing operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReindexingResponseDto"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"SearchIndexingController.initiateReindexing"}},"/schemas/{schema_version}":{"delete":{"x-controller-name":"SchemasController","x-operation-name":"deleteSchema","tags":["SchemasController"],"security":[{"cookieAuth":[]}],"description":"Delete a schema for the provided schema version.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Schema DELETE success."},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the schema."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns if the schema is active and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"schema_version","in":"path","schema":{"type":"string"},"description":"Provide the schema version. e.g., 1.0.0","required":true}],"operationId":"SchemasController.deleteSchema"}},"/schemas":{"get":{"x-controller-name":"SchemasController","x-operation-name":"getSchemas","tags":["SchemasController"],"security":[{"cookieAuth":[]}],"description":"This API will return the list of schemas.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Array of schemas.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContentResponse"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"SchemasController.getSchemas"}},"/staging/mismatches":{"get":{"x-controller-name":"StagingController","x-operation-name":"getStagingMismatchLogs","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the staging mismatch logs for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an array of staging mismatch logs"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriberId","in":"query","schema":{"type":"string"},"description":"Provide the subscriber id.
","required":false},{"name":"recordAction","in":"query","schema":{"type":"string","enum":["CREATE","UPDATE","DELETE"],"example":""},"description":"Provide the staging recordAction.","required":false},{"name":"recordType","in":"query","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP","PERMISSION","RESOURCE"],"example":""},"description":"Provide the recordType.","required":false},{"name":"offset","in":"query","schema":{"type":"string"},"description":"Provide the offset for pagination (e.g. 0).","required":false},{"name":"limit","in":"query","schema":{"type":"string"},"description":"Provide the number of records to be fetched for pagination (e.g. 10).","required":false}],"operationId":"StagingController.getStagingMismatchLogs"},"delete":{"x-controller-name":"StagingController","x-operation-name":"deleteStagingMismatchLogs","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes all staging mismatch logs for the provided subscriber target host.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Successfully deletes the staging mismatch logs"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriberId","in":"query","schema":{"type":"string"},"description":"Provide the subscriber id.
","required":false}],"operationId":"StagingController.deleteStagingMismatchLogs"}},"/staging/records/{recordType}/summary":{"get":{"x-controller-name":"StagingController","x-operation-name":"getRecordsSummary","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the summary of records for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an object containing count"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true}],"operationId":"StagingController.getRecordsSummary"}},"/staging/records/{recordType}/{id}":{"get":{"x-controller-name":"StagingController","x-operation-name":"getRecord","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will validate if record exists for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns record details with status code if record exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StagingRecordDetailsResponseDto"}}}},"204":{"description":"Returns only success status code if records exists"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"id","in":"path","schema":{"type":"string"},"description":"Provide the id for record to check. e.g., 960a78a8bcece8c66a305b7c902d328d","required":true},{"name":"details","in":"query","schema":{"type":"boolean"},"description":"To get record details set as true or false. (e.g true)."}],"operationId":"StagingController.getRecord"}},"/staging/records/{recordType}":{"get":{"x-controller-name":"StagingController","x-operation-name":"generateHash","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the hash value for records based on the filter criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an object containing hash count and id (if the limit value passed is 1) information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset number to fetch record. e.g., 5.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the limit number to fetch record. e.g., 10.","required":true}],"operationId":"StagingController.generateHash"}},"/staging/records":{"get":{"x-controller-name":"StagingController","x-operation-name":"getHashList","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the list of id and hash value for records within range of first and last id.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an array containing id and hash list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashListResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"query","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"firstId","in":"query","schema":{"type":"string"},"description":"Provide the first id for record range. e.g., 0407f224-14aa-49a3-abd4-b31d6c0e01e9.","required":false},{"name":"lastId","in":"query","schema":{"type":"string"},"description":"Provide the last id for record range. e.g., ce749387-1a7d-44af-9e8e-339ca7e3e3e9.","required":false},{"name":"collectionId","in":"query","schema":{"type":"string"},"description":"Provide collection id for record type MEDIA_ITEM, RENDITION, VERSION, FAVORITE, KEYWORD and CUSTOM_URL. e.g., 6f0e4e77-4255-454b-ba34-8462fa3ff596.","required":false}],"operationId":"StagingController.getHashList"}},"/staging/subscriber/{subscriber_id}":{"patch":{"x-controller-name":"StagingController","x-operation-name":"updateSubscriberData","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This PATCH operation updates subscriber details.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the updated subsciber information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistration"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the target host field of subscriber registration.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationReqPartial"}}},"x-parameter-index":2},"operationId":"StagingController.updateSubscriberData"},"get":{"x-controller-name":"StagingController","x-operation-name":"findById","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the details of subscriber for the provided subscriber id.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of the subscriber.
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistration"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the subscriber id.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"operationId":"StagingController.findById"},"delete":{"x-controller-name":"StagingController","x-operation-name":"delete","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes a subscriber registration for the provided subscriber target host.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Successfully deletes the subscriber registration"},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the target host field of subscriber registration.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"operationId":"StagingController.delete"}},"/staging/subscriber":{"post":{"x-controller-name":"StagingController","x-operation-name":"create","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a list of new Subscriber Registration.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of newly created subscriber registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationReq"}}},"description":"This POST operation creates a list of new Subscriber Registration.
","x-parameter-index":1},"operationId":"StagingController.create"},"get":{"x-controller-name":"StagingController","x-operation-name":"findAll","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the details of all the subscribers.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of all the subscribers.
","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberRegistration"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"StagingController.findAll"}}},"components":{"schemas":{"ApiVersionResponseDto":{"title":"ApiVersionResponseDto","type":"object","properties":{"version":{"type":"string","description":"Specifies Api version details."}},"required":["version"],"additionalProperties":false},"MediaTypeResponseDto":{"title":"MediaTypeResponseDto","type":"object","properties":{"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}}},"required":["mimeType","extensions"],"additionalProperties":false},"MediaItemsResponseDto":{"title":"MediaItemsResponseDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mediaTypeId":{"type":"string"},"userId":{"type":"string"},"metadata":{"type":"object"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"keywordDetails":{"type":"object"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"scanStatus":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"isFavorite":{"type":"boolean","description":"Provide the isFavorites value to filter the favorite records (e.g true)."},"collectionIds":{"type":"array","items":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"mediaType":{"$ref":"#/components/schemas/MediaTypeResponseDto"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail media storage ID (e.g 892a60f3-7fe9-4e4b-b65c-b8afe5314a33).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"thumbnailFileSize":{"type":"number","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"size":{"type":"number","description":"Specifies the size."},"version":{"type":"number","description":"Specifies the version of the rendition."},"isUnique":{"type":"boolean","description":"Provide the isUnique value to identify the duplicate filename in a collection (e.g. true)."}},"required":["id","name","mediaTypeId","userId","created","updated","scanStatus"],"additionalProperties":false},"MediaItemResponseDto":{"title":"MediaItemResponseDto","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."},"errorMessage":{"type":"string","description":"Operation error message."},"mediaInfo":{"$ref":"#/components/schemas/MediaItemsResponseDto"}},"required":["isSuccess","errorMessage","mediaInfo"],"additionalProperties":false},"MediaReqCreate":{"title":"MediaReqCreate","type":"object","properties":{"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"keywordDetails":{"type":"array","items":{"type":"object","description":"Media asset file keywords."}},"multerFile":{"type":"object","description":"Specifies the file."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"name":{"type":"string","description":"Specifies the media asset name.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"number","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"number","description":"Specifies the size.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaTypeId":{"type":"string","description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailFileSize":{"type":"number","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"sourceMediaId":{"type":"string","description":"Specifies the media asset id to be copied.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"additionalProperties":false},"MediaReq":{"title":"MediaReq","type":"object","properties":{"multerFile":{"type":"object","description":"Specifies the file."},"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"keywordDetails":{"type":"array","items":{"type":"object","description":"Media asset file keywords."}},"collectionIds":{"type":"array","items":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the asset has to be moved"},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"name":{"type":"string","description":"Specifies the media asset name.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"resetKeywords":{"type":"boolean"},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["multerFile"],"additionalProperties":false},"TotalObjectDto":{"title":"TotalObjectDto","type":"object","properties":{"videos":{"type":"string","description":"Specifies videos count in the collection."},"images":{"type":"string","description":"Specifies images count in the collection."},"documents":{"type":"string","description":"Specifies documents count in the collection."},"collections":{"type":"string","description":"Specifies the collections count in the collection."},"items":{"type":"string","description":"Specifies the total count for items in the collection."}},"additionalProperties":false},"CollectionResponseSelfDto":{"title":"CollectionResponseSelfDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uniqueName":{"type":"string"},"isCustomUniqueName":{"type":"boolean"},"location":{"type":"string"},"userid":{"type":"string"},"parentid":{"type":"string"},"rootparentid":{"type":"string"},"accessreferenceid":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"editable":{"type":"boolean","description":"Specifies the editable permission."},"deletable":{"type":"boolean","description":"Specifies the deletable permission."},"accessible":{"type":"boolean","description":"Specifies any permission."},"total":{"$ref":"#/components/schemas/TotalObjectDto"}},"required":["id","name","uniqueName","created","updated"],"additionalProperties":false},"CollectionReq":{"title":"CollectionReq","type":"object","properties":{"name":{"type":"string","description":"Specifies the name."},"id":{"type":"string","description":"Provide the collectionID. e.g., 069b5892-1b5e-4ef6-bf50-65702267b149.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Specifies the description.","nullable":true},"uniqueName":{"type":"string","description":"Provide the unique collection name for the collection (e.g: unique_collection)."},"isCustomUniqueName":{"type":"boolean","description":"Provide the isCustomUniqueName value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"inheritFromParent":{"type":"boolean","description":"Provide the inheritFromParent value for the collection"},"location":{"type":"string","description":"Provide the location value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"parentid":{"type":"string","description":"Provide the parent ID. e.g., 26c9ad35-5376-4f79-b391-235c946a9fc2."},"rootparentid":{"type":"string"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the collection has to be moved."},"accessreferenceid":{"type":"string","description":"Provide accessreferenceid of the collection e.g., Z1UGeAeGHDI3HL6O9E4JM462BDAMMG65JPCJM8C6BD0JMO6LPD03P86MPD4MOG6P1..
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userid":{"type":"string","description":"Provide the userid of the collection. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time when collections was created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time when collections was updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"permissionDetails":{"type":"object","description":"Permission or access details."}},"required":["name"],"additionalProperties":false},"CollectionReqPartial":{"title":"CollectionReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"name":{"type":"string","description":"Specifies the name."},"id":{"type":"string","description":"Provide the collectionID. e.g., 069b5892-1b5e-4ef6-bf50-65702267b149.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Specifies the description.","nullable":true},"uniqueName":{"type":"string","description":"Provide the unique collection name for the collection (e.g: unique_collection)."},"isCustomUniqueName":{"type":"boolean","description":"Provide the isCustomUniqueName value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"inheritFromParent":{"type":"boolean","description":"Provide the inheritFromParent value for the collection"},"location":{"type":"string","description":"Provide the location value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"parentid":{"type":"string","description":"Provide the parent ID. e.g., 26c9ad35-5376-4f79-b391-235c946a9fc2."},"rootparentid":{"type":"string"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the collection has to be moved."},"accessreferenceid":{"type":"string","description":"Provide accessreferenceid of the collection e.g., Z1UGeAeGHDI3HL6O9E4JM462BDAMMG65JPCJM8C6BD0JMO6LPD03P86MPD4MOG6P1..
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userid":{"type":"string","description":"Provide the userid of the collection. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time when collections was created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time when collections was updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"permissionDetails":{"type":"object","description":"Permission or access details."}},"additionalProperties":false,"x-typescript-type":"Partial"},"CollectionPath":{"title":"CollectionPath","type":"object","properties":{"name":{"type":"string","description":"Specifies the collection name."},"id":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"additionalProperties":false},"ThumbnailObjectDto":{"title":"ThumbnailObjectDto","type":"object","properties":{"mediaName":{"type":"string","description":"Specifies the media asset name."},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."}},"additionalProperties":false},"CollectionResponseDto":{"title":"CollectionResponseDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uniqueName":{"type":"string"},"isCustomUniqueName":{"type":"boolean"},"location":{"type":"string"},"userid":{"type":"string"},"parentid":{"type":"string"},"rootparentid":{"type":"string"},"accessreferenceid":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"total":{"$ref":"#/components/schemas/TotalObjectDto"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/ThumbnailObjectDto"}},"editable":{"type":"boolean","description":"Specifies the editable permission."},"deletable":{"type":"boolean","description":"Specifies the deletable permission."},"rootaccessreferenceid":{"type":"string","description":"Specifies the access reference id"},"accessible":{"type":"boolean","description":"Specifies any permission."}},"required":["id","name","uniqueName","created","updated"],"additionalProperties":false},"CollectionListResponseDto":{"title":"CollectionListResponseDto","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"paths":{"type":"array","items":{"$ref":"#/components/schemas/CollectionPath"}},"contents":{"type":"array","items":{"$ref":"#/components/schemas/CollectionResponseDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"AssetsReferecesTypeDataDto":{"title":"AssetsReferecesTypeDataDto","type":"object","properties":{"type":{"type":"string","description":"Specifies the asset reference type such as Collection, Component, Content and ContentTemplate."},"data":{"type":"object","description":"Specifies the asset reference details."}},"additionalProperties":false},"AssetReferencesResponse":{"title":"AssetReferencesResponse","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AssetsReferecesTypeDataDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"RenditionPayloadDto":{"title":"RenditionPayloadDto","type":"object","properties":{"id":{"type":"string","description":"Specifies the ID field of rendition"},"latestVersion":{"type":"number","description":"Specifies the version of the rendition."},"description":{"type":"string","description":"Specifies the actions performed on the version"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"name":{"type":"string","description":"Specifies the name."},"title":{"type":"string","description":"Specifies the title of the media item"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileExtension":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"createdBy":{"type":"string","description":"Specifies who created the rendition"},"updatedBy":{"type":"string","description":"Specifies who modified the rendition"},"created":{"type":"string","format":"date-time","description":"Specifies date and time when renditions were created"},"updated":{"type":"string","format":"date-time","description":"Specifies date and time when renditions were updated"},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail mediastorageid of rendition (e.g. 276504533-a8c3-4f3f-b855-b3253184061c).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"FavoriteRsp":{"title":"FavoriteRsp","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."},"mediaItemId":{"type":"string","description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car."},"message":{"type":"string","description":"Specifies the message."},"created":{"type":"string","description":"Specifies date and time when favorites were created.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"updated":{"type":"string","description":"Specifies date and time when favorites were updated.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"required":["isSuccess","mediaItemId","message"],"additionalProperties":false},"FavoriteReq":{"title":"FavoriteReq","type":"object","properties":{"mediaItemIds":{"type":"array","items":{"type":"string","description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car."}},"userId":{"type":"string","description":"Specifies the userID. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when favorites were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when favorites were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["mediaItemIds"],"additionalProperties":false},"Favorite":{"title":"Favorite","type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"mediaId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["userId","created","updated"],"additionalProperties":false},"MediaPayload":{"title":"MediaPayload","type":"object","properties":{"id":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"name":{"type":"string"},"userId":{"type":"string"},"size":{"type":"number"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"mediaType":{"$ref":"#/components/schemas/MediaTypeResponseDto"},"metadata":{"type":"object"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"isFavorite":{"type":"boolean","description":"Provide the isFavorites value to filter the favorite records (e.g true)."},"isUnique":{"type":"boolean","description":"Provide the isUnique value to identify the duplicate filename in a collection (e.g. true)."}},"required":["id","created","updated","name","userId","size","self","mediaType","thumbnailUrl","binaryUrl","isFavorite"],"additionalProperties":false},"MediaItemsResponse":{"title":"MediaItemsResponse","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaPayload"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"MediaTypeGroupReq":{"title":"MediaTypeGroupReq","type":"object","properties":{"name":{"type":"string","description":"Specifies the name."},"description":{"type":"string","description":"Specifies the description."},"maxFileSize":{"type":"number","description":"Specifies the size."},"id":{"type":"string","description":"Provides media group type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media type groups were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media type groups were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["name","description","maxFileSize"],"additionalProperties":false},"MediaTypeResponsePayload":{"title":"MediaTypeResponsePayload","type":"object","properties":{"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}},"mediaTypeGroupId":{"type":"string"},"enabled":{"type":"boolean"}},"required":["mimeType","extensions","mediaTypeGroupId"],"additionalProperties":false},"MediaTypeGroupDto":{"title":"MediaTypeGroupDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"maxFileSize":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"mediaTypes":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeResponsePayload"}}},"required":["id","name","description","maxFileSize","created","updated"],"additionalProperties":false},"MediaTypeGroupResponse":{"title":"MediaTypeGroupResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeGroupDto"}}},"additionalProperties":false},"MediaTypeGroupReqPartial":{"title":"MediaTypeGroupReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"name":{"type":"string","description":"Specifies the name."},"description":{"type":"string","description":"Specifies the description."},"maxFileSize":{"type":"number","description":"Specifies the size."},"id":{"type":"string","description":"Provides media group type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media type groups were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media type groups were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"additionalProperties":false,"x-typescript-type":"Partial"},"MediaTypeGroup":{"title":"MediaTypeGroup","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"maxFileSize":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["id","name","description","maxFileSize","created","updated"],"additionalProperties":false},"MediaTypeDto":{"title":"MediaTypeDto","type":"object","properties":{"id":{"type":"string"},"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}},"mediaTypeGroupId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"type":{"type":"string","description":"Specifies the media asset type."}},"required":["mimeType","extensions","created","updated"],"additionalProperties":false},"MediaTypeReq":{"title":"MediaTypeReq","type":"object","properties":{"mimeType":{"type":"string","description":"Specifies the media asset type."},"extensions":{"type":"array","items":{"type":"string","description":"Specifies the extensions."}},"mediaTypeGroupId":{"type":"string","description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675)."},"id":{"type":"string","description":"Provides media type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media types were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media types were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"enabled":{"type":"boolean","description":"`true` or `false` should be passed in order to enable or disable the mime type.
"}},"required":["mimeType","extensions"],"additionalProperties":false},"MediaTypesResponse":{"title":"MediaTypesResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeDto"}}},"additionalProperties":false},"MediaTypeReqPartial":{"title":"MediaTypeReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"mimeType":{"type":"string","description":"Specifies the media asset type."},"extensions":{"type":"array","items":{"type":"string","description":"Specifies the extensions."}},"mediaTypeGroupId":{"type":"string","description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675)."},"id":{"type":"string","description":"Provides media type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media types were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media types were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"enabled":{"type":"boolean","description":"`true` or `false` should be passed in order to enable or disable the mime type.
"}},"additionalProperties":false,"x-typescript-type":"Partial"},"Operation":{"title":"Operation","type":"object","properties":{"id":{"type":"string"},"triggerFunction":{"type":"string"},"inputs":{"type":"object"},"status":{"type":"string"},"errorInfo":{"type":"object"},"retryCounter":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"owner":{"type":"number"},"priority":{"type":"number"}},"required":["id","triggerFunction","inputs","status","retryCounter","created","updated"],"additionalProperties":false},"RenditionRequest":{"title":"RenditionRequest","type":"object","properties":{"id":{"type":"string","description":"provide the ID field of rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaItemId":{"type":"string","description":"Provide the media item Id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"renditionType":{"type":"string","description":"Provide the rendition type, such as desktop, tablet, mobile etc.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time to specify when rendition were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time to specify when rendition were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"createdBy":{"type":"string","description":"Provide the info who created rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updatedBy":{"type":"string","description":"Provide the info who updated rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"customUrl":{"type":"string","description":"Media Asset Custom URLNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"string","description":"Provide the file size in bytes. (e.g. 100, 1000)Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"multerFile":{"type":"object","description":"Specifies the file."}},"additionalProperties":false},"MediaRequest":{"title":"MediaRequest","type":"object","properties":{"description":{"type":"string","description":"Specifies the version description"},"actions":{"type":"object","description":"Specifies the action description"},"multerFile":{"type":"object","description":"Specifies the file."},"customUrl":{"type":"string","description":"Media Asset Custom URLNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the ID field of version.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"number","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaStorageId":{"type":"string","description":"Specifies the media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"createdBy":{"type":"string","description":"Specifies who created the rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updatedBy":{"type":"string","description":"Specifies who updated the rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies the date and time when versions were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies the date and time when versions were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"string","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"number","description":"Provide the file size in bytes. (e.g. 100, 1000)Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"removeExistingKeywords":{"type":"boolean","description":"Specifies old keyword retention"},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."}},"additionalProperties":false},"VersionResponseDetailsDto":{"title":"VersionResponseDetailsDto","type":"object","properties":{"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"id":{"type":"string","description":"Specifies the ID field of version"},"renditionId":{"type":"string","description":"Specifies the ID field of rendition"},"version":{"type":"number","description":"Specifies the version of the rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"description":{"type":"string","description":"Specifies the description of the media item"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"title":{"type":"string","description":"Specifies the title of the media item"},"itemDescription":{"type":"string","description":"Specifies the actions performed on the version"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the mime-type of the media item. e.g., image/jpeg"},"createdBy":{"type":"string","description":"Specifies who created the version"},"updatedBy":{"type":"string","description":"Specifies who modified the version"},"created":{"type":"string","description":"Specifies date and time when versions were created"},"updated":{"type":"string","description":"Specifies date and time when versions were updated"},"mediaStorageId":{"type":"string","description":"Specifies the ID field of media storage.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"VersionListResponseDto":{"title":"VersionListResponseDto","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/VersionResponseDetailsDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"VersionPayloadDto":{"title":"VersionPayloadDto","type":"object","properties":{"id":{"type":"string","description":"Provide the version ID. e.g., 0j06cc1c-bb99-48b3-b8ff-4e5de51b4b59 or version number. e.g., 1."},"version":{"type":"number","description":"Specifies the version of the rendition."},"description":{"type":"string","description":"Specifies the actions performed on the version"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"name":{"type":"string","description":"Specifies the name."},"title":{"type":"string","description":"Specifies the title of the media item"},"itemDescription":{"type":"string","description":"Specifies the actions performed on the version"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileExtension":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"createdBy":{"type":"string","description":"Specifies who created the version"},"updatedBy":{"type":"string","description":"Specifies who modified the version"},"created":{"type":"string","format":"date-time","description":"Specifies date and time when versions were created"},"updated":{"type":"string","format":"date-time","description":"Specifies date and time when versions were updated"},"mediaStorageId":{"type":"string","description":"Specifies the ID field of media storage.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"RenditionTypeResponseDto":{"title":"RenditionTypeResponseDto","type":"object","properties":{"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"id":{"type":"string","description":"Specifies the ID field of rendition"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"mimeType":{"type":"string","description":"Specifies the mime-type of the media item. e.g., image/jpeg"},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"createdBy":{"type":"string","description":"Specifies who created the rendition"},"updatedBy":{"type":"string","description":"Specifies who modified the rendition"},"created":{"type":"string","description":"Specifies date and time when renditions were created"},"updated":{"type":"string","description":"Specifies date and time when renditions were updated"},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail mediastorageid of rendition (e.g. 276504533-a8c3-4f3f-b855-b3253184061c).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"RenditionListResponse":{"title":"RenditionListResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/RenditionTypeResponseDto"}}},"additionalProperties":false},"Schema":{"title":"Schema","type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"status":{"type":"string"}},"required":["name","version","status"],"additionalProperties":false},"SchemaContentResponse":{"title":"SchemaContentResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}}},"additionalProperties":false},"ReindexingResponseDto":{"title":"ReindexingResponseDto","type":"object","properties":{"status":{"type":"string","description":"Speacifies successful initiate search reindexing"}},"required":["status"],"additionalProperties":false},"SubscriberRegistrationResponseDto":{"title":"SubscriberRegistrationResponseDto","type":"object","properties":{"id":{"type":"string"},"targetHost":{"type":"string"},"syncStatus":{"type":"string"},"syncFailureLogs":{"type":"string"},"lastSyncTime":{"type":"string","format":"date-time"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"isSuccess":{"type":"boolean","description":"Operation success status."},"errorMessage":{"type":"string","description":"Operation error message."}},"required":["id","targetHost","status","created","updated","isSuccess","errorMessage"],"additionalProperties":false},"SubscriberRegistrationReq":{"title":"SubscriberRegistrationReq","type":"object","properties":{"targetHost":{"type":"string"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"lastSyncTime":{"type":"string","format":"date-time"},"syncStatus":{"type":"string"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"syncFailureLogs":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["targetHost"],"additionalProperties":false},"SubscriberRegistration":{"title":"SubscriberRegistration","type":"object","properties":{"id":{"type":"string"},"targetHost":{"type":"string"},"syncStatus":{"type":"string"},"syncFailureLogs":{"type":"string"},"lastSyncTime":{"type":"string","format":"date-time"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["id","targetHost","status","created","updated"],"additionalProperties":false},"SubscriberRegistrationReqPartial":{"title":"SubscriberRegistrationReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"targetHost":{"type":"string"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"lastSyncTime":{"type":"string","format":"date-time"},"syncStatus":{"type":"string"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"syncFailureLogs":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"additionalProperties":false,"x-typescript-type":"Partial"},"HashResponseDto":{"title":"HashResponseDto","type":"object","properties":{"hash":{"type":"string","description":"Specify the hash for range of records.
"},"count":{"type":"number","description":"Specify the count for number of records for which hash been generated.
"},"id":{"type":"string","description":"Specify the id for individual record for which hash been generated.
"}},"required":["hash","count","id"],"additionalProperties":false},"RecordHashDto":{"title":"RecordHashDto","type":"object","properties":{"id":{"type":"string","description":"Specify the id for individual record for which hash been generated.
"},"hash":{"type":"string","description":"Specify the hash for range of records.
"}},"required":["id","hash"],"additionalProperties":false},"HashListResponseDto":{"title":"HashListResponseDto","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/RecordHashDto"}}},"additionalProperties":false},"StagingRecordDetailsResponseDto":{"title":"StagingRecordDetailsResponseDto","type":"object","properties":{"collection":{"type":"object"},"mediaItem":{"type":"object"},"rendition":{"type":"object"},"version":{"type":"object"},"customUrl":{"type":"object"},"keyword":{"type":"object"},"mediaType":{"type":"object"},"mediaTypeGroup":{"type":"object"},"resourceId":{"type":"string"},"permission":{"type":"array","items":{"type":"object"}}},"additionalProperties":false},"SubscriberInterfaceResponseDto":{"title":"SubscriberInterfaceResponseDto","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."}},"required":["isSuccess"],"additionalProperties":false},"SubscriberInterfaceReq":{"title":"SubscriberInterfaceReq","type":"object","properties":{"eventData":{"type":"object","description":"Specifies the event data.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"host":{"type":"string","description":"Specifies the host.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"type":{"type":"string","description":"Specifies the event type.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"action":{"type":"string","description":"Specifies the event actions. (e.g. CREATE, UPDATE, DELETE)
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","format":"date-time","description":"Provide the date and time to specify when event data were created.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["eventData","host","type","action","created"],"additionalProperties":false}},"securitySchemes":{"cookieAuth":{"description":"LtpaToke2 is going to identifying the user session.","type":"apiKey","in":"cookie","name":"LtpaToken2"}}},"servers":[{"url":"/dx/api/dam/v1"}]} \ No newline at end of file +{"openapi":"3.0.0","info":{"title":"Digital Asset Management API","version":"1.36.0","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management features of HCL DX 9.5","contact":{}},"paths":{"/api-version":{"get":{"x-controller-name":"ApiVersionController","x-operation-name":"findVersion","tags":["ApiVersionController"],"security":[{"cookieAuth":[]}],"description":"This will retrieve the API versions.","responses":{"200":{"description":"Array of api version.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersionResponseDto"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"ApiVersionController.findVersion"}},"/collections/{collection_id}/items/{item_id}/references":{"get":{"x-controller-name":"CollectionController","x-operation-name":"getMediaReferences","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"View reference details of media assets.","responses":{"200":{"description":"Array of media asset items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetReferencesResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records."},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."}],"operationId":"CollectionController.getMediaReferences"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}/versions/{version_id}":{"get":{"x-controller-name":"RenditionController","x-operation-name":"getVersionById","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve version data as per the provided version id.","responses":{"200":{"description":"Retrieve versions list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionPayloadDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"version_id","in":"path","schema":{"type":"string"},"description":"Provide the version ID. e.g., 0j06cc1c-bb99-48b3-b8ff-4e5de51b4b59 or version number. e.g., 1.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true).","required":false},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"RenditionController.getVersionById"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}/versions":{"get":{"x-controller-name":"RenditionController","x-operation-name":"getVersions","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve versions list as per the provided rendition id.","responses":{"200":{"description":"Retrieve versions list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionListResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records (e.g. 'created', 'updated', 'version', 'createdBy', 'updatedBy') "},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."}],"operationId":"RenditionController.getVersions"}},"/collections/{collection_id}/items/{item_id}/renditions/{rendition_id}":{"put":{"x-controller-name":"RenditionController","x-operation-name":"replaceRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will create new version for the provided rendition id.","responses":{"200":{"description":"Updates rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"description":{"type":"string"},"actions":{"type":"object"},"removeExistingKeywords":{"type":"boolean"},"addNewKeywords":{"type":"boolean"},"customUrl":{"type":"string"},"id":{"type":"string"},"version":{"type":"string"},"mediaStorageId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"metadata":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":4},"operationId":"RenditionController.replaceRendition"},"patch":{"x-controller-name":"RenditionController","x-operation-name":"updateRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will update the part of the rendition.","responses":{"200":{"description":"Retrieves the updated rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"customUrl":{"type":"string"},"updatedBy":{"type":"string"},"updated":{"type":"string"},"mediaStorageId":{"type":"string"},"id":{"type":"string"},"version":{"type":"string"},"createdBy":{"type":"string"},"created":{"type":"string"},"metadata":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":4},"operationId":"RenditionController.updateRendition"},"get":{"x-controller-name":"RenditionController","x-operation-name":"getRenditionById","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API retrieves rendition data as per the provided rendition id.","responses":{"200":{"description":"Retrieve renditions data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"rendition_id","in":"path","schema":{"type":"string"},"description":"Provide the rendition ID. e.g., 0h06cc1c-bb99-48b3-b8ff-4e5de51b4b90 or rendition type. e.g., Desktop.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"thumbnail","in":"query","schema":{"type":"boolean"},"description":"To get thumbnail data, set as true or false (e.g. true)."},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true)."},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"RenditionController.getRenditionById"}},"/collections/{collection_id}/items/{item_id}/renditions":{"post":{"x-controller-name":"RenditionController","x-operation-name":"createRendition","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API wil create new rendition.","responses":{"200":{"description":"Creates rendition information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenditionPayloadDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"id":{"type":"string"},"mediaItemId":{"type":"string"},"renditionType":{"type":"string"},"thumbnailMediaStorageId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"file":{"type":"string","format":"binary"},"customUrl":{"type":"string"},"fileSize":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"RenditionController.createRendition"},"get":{"x-controller-name":"RenditionController","x-operation-name":"getRenditions","tags":["RenditionController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve renditions list as per the provided item id.","responses":{"200":{"description":"Retrieve rendition list.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RenditionListResponse"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"download","in":"query","schema":{"type":"boolean"},"description":"To get download data set as true or false. (e.g true).","required":false},{"name":"fileName","in":"query","schema":{"type":"string"},"description":"Provide the download file name. (default: download)","required":false},{"name":"downloadType","in":"query","schema":{"type":"string","enum":["rendition","original","all"],"example":"all"},"description":"Provide the download type. (e.g. 'all', 'original', 'rendition')","required":false}],"operationId":"RenditionController.getRenditions"}},"/collections/{collection_id}/items/{item_id}":{"put":{"x-controller-name":"CollectionController","x-operation-name":"replaceMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This API will replace item for provided item id.","responses":{"200":{"description":"Successful response on updating media asset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"collectionIds":{"type":"array","items":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"resetKeywords":{"type":"boolean","items":{"type":"boolean"},"description":"Delete existing keywords and triggers supplemental stack"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"CollectionController.replaceMediaItem"},"patch":{"x-controller-name":"CollectionController","x-operation-name":"updateMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Replaces part of item.","responses":{"200":{"description":"Updated media asset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference check for the Media Asset"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"collectionIds":{"type":"array","items":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords."},"name":{"type":"string","items":{"type":"string"},"description":"Specifies the name."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"resetKeywords":{"type":"boolean","items":{"type":"boolean"},"description":"Delete existing keywords and triggers supplemental stack"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the asset has to be moved"}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":3},"operationId":"CollectionController.updateMediaItem"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getMediaByIdFromCollection","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve information on the media asset. Also it can retrieve thumbnail or binary data.","responses":{"200":{"description":"Information on the media asset or thumbnail or binary data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemsResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"binary","in":"query","schema":{"type":"boolean"},"description":"To get Binary data set as true or false."},{"name":"thumbnail","in":"query","schema":{"type":"boolean"}},{"name":"Range","in":"header","schema":{"type":"string"}}],"operationId":"CollectionController.getMediaByIdFromCollection"},"delete":{"x-controller-name":"CollectionController","x-operation-name":"deleteMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Delete a media asset from the specified collection.","responses":{"204":{"description":"Media asset DELETE success."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the Media Asset."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"405":{"description":"Returns if the Media Asset is referenced and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"item_id","in":"path","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference check for the Media Asset"}],"operationId":"CollectionController.deleteMediaItem"}},"/collections/{collection_id}/items":{"post":{"x-controller-name":"CollectionController","x-operation-name":"createMediaItem","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This API will create a new item.","responses":{"200":{"description":"Successful response on creating item.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"name":{"type":"string","description":"Specifies the media asset name.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media item were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"keywords":{"type":"array","items":{"type":"string"},"description":"Media asset file keywords.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"title":{"type":"string","description":"Media asset file title.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"string","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"string","description":"Specifies the size.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"string","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaTypeId":{"type":"string","description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailFileSize":{"type":"string","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"keywordDetails":{"type":"array","items":{"type":"object"},"description":"Media asset file keywords."},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}}}}},"description":"Media multipart/form-data for update rendition.","required":true,"x-parameter-index":2},"operationId":"CollectionController.createMediaItem"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getItemsByCollectionId","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve media assets/collections inside collection based on the type with filter criteria.","responses":{"200":{"description":"Array of media assets/collections under collection retrieved based on the type with filter criteria.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MediaItemsResponse"},{"$ref":"#/components/schemas/CollectionListResponseDto"}]},"example":{"offset":0,"limit":0,"total":0,"self":"string","first":"string","prev":"string","next":"string","last":"string","paths":[{"name":"string","id":"string"}],"contents":[{"id":"string","name":"string","description":"string","userid":"string","parentid":"string","rootparentid":"string","accessreferenceid":"string","created":"2020-07-13T12:14:34.056Z","updated":"2020-07-13T12:14:34.056Z","self":"string","total":{"videos":"string","images":"string","documents":"string","collections":"string","items":"string"},"thumbnails":[{"mediaName":"string","mimeType":"string","self":"string"}],"editable":true,"deletable":true,"accessible":true,"rootaccessreferenceid":"string"}]}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"filterAccess","in":"query","schema":{"type":"string"},"description":"Provide the access way either READ or WRITE."},{"name":"type","in":"query","schema":{"type":"string","enum":["item","collection"],"default":"item","example":"item"},"description":"Specifies the result set to return (collections or items) under a collection."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records.
This filter will be applied only for type=item"},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC.
This filter will be applied only for type=item"},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}},{"name":"isFavorite","in":"query","schema":{"type":"boolean"},"description":"Provide the isFavorites value to filter the favorite records (e.g true).
This filter will be applied only for type=item"},{"name":"fileType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."}}},{"name":"minFileSize","in":"query","schema":{"type":"number"},"description":"Provide the minimum size in bytes to filter media items. (e.g. 0, 10)"},{"name":"maxFileSize","in":"query","schema":{"type":"number"},"description":"Provide the maximum size in bytes to filter media items. (e.g. 100, 1000)"}],"operationId":"CollectionController.getItemsByCollectionId"}},"/collections/{collection_id}":{"put":{"x-controller-name":"CollectionController","x-operation-name":"replaceById","tags":["CollectionController"],"description":"Replaces full collection.","security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Returns updated collection information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReq"}}},"x-parameter-index":2},"operationId":"CollectionController.replaceById"},"patch":{"x-controller-name":"CollectionController","x-operation-name":"updateById","tags":["CollectionController"],"description":"Updates part of the collection.","security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Collection PATCH success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReqPartial"}}},"x-parameter-index":2},"operationId":"CollectionController.updateById"},"get":{"x-controller-name":"CollectionController","x-operation-name":"findById","tags":["CollectionController"],"description":"This GET operation retrieves the Digital Asset Management collection.","responses":{"200":{"description":"Returns an object containing collection information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true}],"operationId":"CollectionController.findById"},"delete":{"x-controller-name":"CollectionController","x-operation-name":"deleteCollectionById","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes media asset collection.","responses":{"204":{"description":"Successfully deletes the collection."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the Collection."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"405":{"description":"Returns if the Media Assets inside the collection are referenced, and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collection_id","in":"path","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6.","required":true},{"name":"ignoreMediaReferences","in":"query","schema":{"type":"boolean"},"description":"Setting this to true, will ignore Reference Check for the Media Assets in side the Collection."}],"operationId":"CollectionController.deleteCollectionById"}},"/collections":{"post":{"x-controller-name":"CollectionController","x-operation-name":"create","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a new media asset collection.","responses":{"200":{"description":"Returns the details of a newly created collection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseSelfDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionReq"}}},"description":"This POST operation creates a new media asset collection.","x-parameter-index":1},"operationId":"CollectionController.create"},"get":{"x-controller-name":"CollectionController","x-operation-name":"getCollections","tags":["CollectionController"],"security":[{"cookieAuth":[]}],"description":"Retrieve the Digital Asset Management collections based on the filter criteria.","responses":{"200":{"description":"Array of Digital Asset Management collections retrieved based on the filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionListResponseDto"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string"},"description":"Provide the access way either READ or WRITE."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"query","in":"query","schema":{"type":"string"},"description":"Provide the keyword to perform search (e.g digital)."},{"name":"searchType","in":"query","schema":{"type":"string"},"description":"Provide the search type using any of [ all, name, description ]."},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}}],"operationId":"CollectionController.getCollections"}},"/eventlogs":{"post":{"x-controller-name":"SubscriberInterfaceController","x-operation-name":"createEvent","tags":["SubscriberInterfaceController"],"security":[{"cookieAuth":[]}],"description":"This API will create operation job for the given event list.
Note: This API will be an interface between a publisher and a subscriber for staging. Only admins will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Created operation job successfully.
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberInterfaceResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberInterfaceReq"}}}},"description":"Provide the event list.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","x-parameter-index":1},"operationId":"SubscriberInterfaceController.createEvent"}},"/favorites":{"post":{"x-controller-name":"FavoriteController","x-operation-name":"create","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will mark media asset as favorite.","responses":{"200":{"description":"Array of marked favorite media asset.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FavoriteRsp"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FavoriteReq"}}},"x-parameter-index":1},"operationId":"FavoriteController.create"},"get":{"x-controller-name":"FavoriteController","x-operation-name":"find","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve all the favorite media asset items.","responses":{"200":{"description":"Array of favorite media asset Items.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Favorite"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"itemId","in":"query","schema":{"type":"string"},"description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}],"operationId":"FavoriteController.find"},"delete":{"x-controller-name":"FavoriteController","x-operation-name":"delete","tags":["FavoriteController"],"security":[{"cookieAuth":[]}],"description":"This API will unmark media asset item as favorite.","responses":{"200":{"description":"Array of unmarked favorite media asset Items.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FavoriteRsp"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FavoriteReq"}}},"x-parameter-index":1},"operationId":"FavoriteController.delete"}},"/mediaitems":{"get":{"x-controller-name":"MediaItemsController","x-operation-name":"search","tags":["MediaItemsController"],"security":[{"cookieAuth":[]}],"description":"The API provides the possibility to search for Digital Asset Management items via search query on the existing meta-data fields using such criteria as name, mime-type, title, keywords, description.","responses":{"200":{"description":"Array of filtered media asset items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaItemsResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"collectionId","in":"query","schema":{"type":"string"},"description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."},{"name":"query","in":"query","schema":{"type":"string"},"description":"Provide the keyword to perform search (e.g digital)."},{"name":"searchType","in":"query","schema":{"type":"string"},"description":"Provide the search type using any of [ all, name, description ]."},{"name":"mediaType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Receive the media asset types, one or more (e.g.[image], [image, video, document])."}}},{"name":"fileType","in":"query","schema":{"type":"array","items":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."}}},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"orderField","in":"query","schema":{"type":"string"},"description":"Provide the field to order the records."},{"name":"orderBy","in":"query","schema":{"type":"string"},"description":"Provide the ordering way either DESC or ASC."},{"name":"isFavorite","in":"query","schema":{"type":"boolean"},"description":"Provide the isFavorites value to filter the favorite records (e.g true)."},{"name":"minFileSize","in":"query","schema":{"type":"number"},"description":"Provide the minimum size in bytes to filter media items. (e.g. 0, 10)"},{"name":"maxFileSize","in":"query","schema":{"type":"number"},"description":"Provide the maximum size in bytes to filter media items. (e.g. 100, 1000)"}],"operationId":"MediaItemsController.search"}},"/mediatypegroups/{mediatypegroup_id}":{"put":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"replaceById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Replaces full media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns updated media asset type group information in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}},"x-parameter-index":2},"operationId":"MediaTypeGroupController.replaceById"},"patch":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"updateById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Updates part of the media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns updated media asset type group information in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReqPartial"}}},"x-parameter-index":2},"operationId":"MediaTypeGroupController.updateById"},"get":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"findById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Retrieve the media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns the details of the media asset type group in Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"operationId":"MediaTypeGroupController.findById"},"delete":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"deleteById","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Deletes a media asset type group and removes all related media asset types which belonged to this media asset type group in Digital Asset Management.","responses":{"204":{"description":"Media assetType Group DELETE success."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatypegroup_id","in":"path","schema":{"type":"string"},"description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).","required":true}],"operationId":"MediaTypeGroupController.deleteById"}},"/mediatypegroups":{"post":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"create","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Creates a new media asset type group in Digital Asset Management.","responses":{"200":{"description":"Returns the details of newly created media asset type group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeGroupReq"}}},"x-parameter-index":1},"operationId":"MediaTypeGroupController.create"},"get":{"x-controller-name":"MediaTypeGroupController","x-operation-name":"findAll","tags":["MediaTypeGroupController"],"security":[{"cookieAuth":[]}],"description":"Retrieve all media asset type groups in Digital Asset Management.","responses":{"200":{"description":"Returns all the media asset type groups in Digital Asset Management.","content":{"application/json":{"schema":{"type":"array","$ref":"#/components/schemas/MediaTypeGroupResponse"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"MediaTypeGroupController.findAll"}},"/mediatypes/{mediatype_id}":{"put":{"x-controller-name":"MediaTypeController","x-operation-name":"replaceById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This PUT operation replaces full Digital Asset Management media asset type.","responses":{"200":{"description":"Returns updated media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeReq"}}},"x-parameter-index":2},"operationId":"MediaTypeController.replaceById"},"patch":{"x-controller-name":"MediaTypeController","x-operation-name":"updateById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This PATCH operation updates part of the Digital Asset Management media asset type.","responses":{"200":{"description":"Returns updated media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeReqPartial"}}},"x-parameter-index":2},"operationId":"MediaTypeController.updateById"},"get":{"x-controller-name":"MediaTypeController","x-operation-name":"findById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This GET operation retrieve the Digital Asset Management media asset type.","responses":{"200":{"description":"Returns an object containing media asset type information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypeDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"operationId":"MediaTypeController.findById"},"delete":{"x-controller-name":"MediaTypeController","x-operation-name":"deleteById","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes a new Digital Asset Management media asset type.","responses":{"204":{"description":"Successfully deletes the media asset type."},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"mediatype_id","in":"path","schema":{"type":"string"},"description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).","required":true}],"operationId":"MediaTypeController.deleteById"}},"/mediatypes":{"post":{"x-controller-name":"MediaTypeController","x-operation-name":"createAll","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a list of new Digital Asset Management media asset types.","responses":{"200":{"description":"Returns the details of newly created media asset types.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeDto"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeReq"}}}},"description":"Returns the details of newly created media asset types.","x-parameter-index":1},"operationId":"MediaTypeController.createAll"},"get":{"x-controller-name":"MediaTypeController","x-operation-name":"findAll","tags":["MediaTypeController"],"security":[{"cookieAuth":[]}],"description":"This GET operation retrieve all the media asset types.","responses":{"200":{"description":"Returns all the media asset types available in the Digital Asset Management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaTypesResponse"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"MediaTypeController.findAll"}},"/operations/{operation_id}":{"post":{"x-controller-name":"OperationController","x-operation-name":"processCallback","tags":["OperationController"],"description":"This API will perform post callback operation","responses":{"200":{"description":"Successful response for generating renditions and thumbnails"},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"operation_id","in":"path","schema":{"type":"string"},"description":"Provide the operation id (Base64 Encoded)","required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":[""],"properties":{"file":{"type":"string","format":"binary"},"downloadURL":{"type":"string"},"error":{"type":"object"},"metadata":{"type":"string","description":"metadata should follow the object `{height: number, width: number, expiryDate: string, alternateText: string, embeddedMetadata: any}`"},"keywords":{"type":"string","description":"keywords should follow the array of object `[{keyword: string, confidencePercentage: string}]`"},"partnerId":{"type":"string"},"entryId":{"type":"string"},"status":{"type":"string"},"delete":{"type":"string"}}}}},"description":"Media multipart/form-data for update rendition.","x-parameter-index":1},"operationId":"OperationController.processCallback"},"get":{"x-controller-name":"OperationController","x-operation-name":"findById","tags":["OperationController"],"security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Operation model instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"operation_id","in":"path","schema":{"type":"string"},"required":true}],"operationId":"OperationController.findById"}},"/operations":{"get":{"x-controller-name":"OperationController","x-operation-name":"find","tags":["OperationController"],"security":[{"cookieAuth":[]}],"responses":{"200":{"description":"Array of Operation model instances","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset for pagination (e.g. 0)."},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the number of records to be fetched for pagination (e.g. 10)."},{"name":"status","in":"query","schema":{"type":"string"},"description":"Status of operation (eg \"TODO\", \"PROCESSING\", \"SUCCESS\", \"ABORT\", \"FAILED\", \"READ\", \"RETRY\", \"WAIT\", \"PENDING\")."},{"name":"triggerFunctions","in":"query","schema":{"type":"string"},"description":"Trigger function of operation."}],"operationId":"OperationController.find"}},"/reindex":{"post":{"x-controller-name":"SearchIndexingController","x-operation-name":"initiateReindexing","tags":["SearchIndexingController"],"security":[{"cookieAuth":[]}],"description":"OPENAPI_SEARCH_REINDEXING_POST_RESPONSE","responses":{"200":{"description":"This API will initiate content-source reindexing operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReindexingResponseDto"}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"SearchIndexingController.initiateReindexing"}},"/schemas/{schema_version}":{"delete":{"x-controller-name":"SchemasController","x-operation-name":"deleteSchema","tags":["SchemasController"],"security":[{"cookieAuth":[]}],"description":"Delete a schema for the provided schema version.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Schema DELETE success."},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns if no permission to delete the schema."},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns if the schema is active and cannot be deleted."},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"schema_version","in":"path","schema":{"type":"string"},"description":"Provide the schema version. e.g., 1.0.0","required":true}],"operationId":"SchemasController.deleteSchema"}},"/schemas":{"get":{"x-controller-name":"SchemasController","x-operation-name":"getSchemas","tags":["SchemasController"],"security":[{"cookieAuth":[]}],"description":"This API will return the list of schemas.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Array of schemas.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaContentResponse"}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"SchemasController.getSchemas"}},"/staging/mismatches":{"get":{"x-controller-name":"StagingController","x-operation-name":"getStagingMismatchLogs","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the staging mismatch logs for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an array of staging mismatch logs"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriberId","in":"query","schema":{"type":"string"},"description":"Provide the subscriber id.
","required":false},{"name":"recordAction","in":"query","schema":{"type":"string","enum":["CREATE","UPDATE","DELETE"],"example":""},"description":"Provide the staging recordAction.","required":false},{"name":"recordType","in":"query","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP","PERMISSION","RESOURCE"],"example":""},"description":"Provide the recordType.","required":false},{"name":"offset","in":"query","schema":{"type":"string"},"description":"Provide the offset for pagination (e.g. 0).","required":false},{"name":"limit","in":"query","schema":{"type":"string"},"description":"Provide the number of records to be fetched for pagination (e.g. 10).","required":false}],"operationId":"StagingController.getStagingMismatchLogs"},"delete":{"x-controller-name":"StagingController","x-operation-name":"deleteStagingMismatchLogs","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes all staging mismatch logs for the provided subscriber target host.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Successfully deletes the staging mismatch logs"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriberId","in":"query","schema":{"type":"string"},"description":"Provide the subscriber id.
","required":false}],"operationId":"StagingController.deleteStagingMismatchLogs"}},"/staging/records/{recordType}/summary":{"get":{"x-controller-name":"StagingController","x-operation-name":"getRecordsSummary","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the summary of records for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an object containing count"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true}],"operationId":"StagingController.getRecordsSummary"}},"/staging/records/{recordType}/{id}":{"get":{"x-controller-name":"StagingController","x-operation-name":"getRecord","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will validate if record exists for the given criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns record details with status code if record exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StagingRecordDetailsResponseDto"}}}},"204":{"description":"Returns only success status code if records exists"},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"id","in":"path","schema":{"type":"string"},"description":"Provide the id for record to check. e.g., 960a78a8bcece8c66a305b7c902d328d","required":true},{"name":"details","in":"query","schema":{"type":"boolean"},"description":"To get record details set as true or false. (e.g true)."}],"operationId":"StagingController.getRecord"}},"/staging/records/{recordType}":{"get":{"x-controller-name":"StagingController","x-operation-name":"generateHash","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the hash value for records based on the filter criteria.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an object containing hash count and id (if the limit value passed is 1) information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"path","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"offset","in":"query","schema":{"type":"number"},"description":"Provide the offset number to fetch record. e.g., 5.","required":true},{"name":"limit","in":"query","schema":{"type":"number"},"description":"Provide the limit number to fetch record. e.g., 10.","required":true}],"operationId":"StagingController.generateHash"}},"/staging/records":{"get":{"x-controller-name":"StagingController","x-operation-name":"getHashList","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the list of id and hash value for records within range of first and last id.
Note: This API will return records for staging environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns an array containing id and hash list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashListResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"recordType","in":"query","schema":{"type":"string","enum":["COLLECTION","MEDIA_ITEM","COLLECTION_MEDIA_RELATION","RENDITION","VERSION","FAVORITE","KEYWORD","CUSTOM_URL","MEDIA_TYPE","MEDIA_TYPE_GROUP"],"example":"COLLECTION"},"description":"Provide the recordType.","required":true},{"name":"firstId","in":"query","schema":{"type":"string"},"description":"Provide the first id for record range. e.g., 0407f224-14aa-49a3-abd4-b31d6c0e01e9.","required":false},{"name":"lastId","in":"query","schema":{"type":"string"},"description":"Provide the last id for record range. e.g., ce749387-1a7d-44af-9e8e-339ca7e3e3e9.","required":false},{"name":"collectionId","in":"query","schema":{"type":"string"},"description":"Provide collection id for record type MEDIA_ITEM, RENDITION, VERSION, FAVORITE, KEYWORD and CUSTOM_URL. e.g., 6f0e4e77-4255-454b-ba34-8462fa3ff596.","required":false}],"operationId":"StagingController.getHashList"}},"/staging/subscriber/{subscriber_id}":{"patch":{"x-controller-name":"StagingController","x-operation-name":"updateSubscriberData","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This PATCH operation updates subscriber details.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the updated subsciber information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistration"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the target host field of subscriber registration.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationReqPartial"}}},"x-parameter-index":2},"operationId":"StagingController.updateSubscriberData"},"get":{"x-controller-name":"StagingController","x-operation-name":"findById","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the details of subscriber for the provided subscriber id.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of the subscriber.
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistration"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the subscriber id.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"operationId":"StagingController.findById"},"delete":{"x-controller-name":"StagingController","x-operation-name":"delete","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This DELETE operation deletes a subscriber registration for the provided subscriber target host.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"204":{"description":"Successfully deletes the subscriber registration"},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}},{"name":"subscriber_id","in":"path","schema":{"type":"string"},"description":"Provide the target host field of subscriber registration.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation.","required":true}],"operationId":"StagingController.delete"}},"/staging/subscriber":{"post":{"x-controller-name":"StagingController","x-operation-name":"create","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This POST operation creates a list of new Subscriber Registration.
Note: This API will enable operation for staging from a different environment. Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of newly created subscriber registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationResponseDto"}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"404":{"description":"Returns the not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"409":{"description":"Returns the duplicate item found error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRegistrationReq"}}},"description":"This POST operation creates a list of new Subscriber Registration.
","x-parameter-index":1},"operationId":"StagingController.create"},"get":{"x-controller-name":"StagingController","x-operation-name":"findAll","tags":["StagingController"],"security":[{"cookieAuth":[]}],"description":"This API will retrieve the details of all the subscribers.
Note: Only admin will be able to access this API. Avoid using this API if you are not aware of its implementation.","responses":{"200":{"description":"Returns the details of all the subscribers.
","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberRegistration"}}}}},"400":{"description":"Returns the bad request error if the input parameters are missing/invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"401":{"description":"Returns the unauthorized error if the ltpa token is not sent/invalid/expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"403":{"description":"Returns the error if you do not have permission to view this","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}},"500":{"description":"Returns the internal server error if the portal server is not reachabale.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"details":{"type":"string"},"uploadExceptionCode":{"type":"string"},"uploadExceptionData":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","schema":{"type":"string"}}],"operationId":"StagingController.findAll"}}},"components":{"schemas":{"ApiVersionResponseDto":{"title":"ApiVersionResponseDto","type":"object","properties":{"version":{"type":"string","description":"Specifies Api version details."}},"required":["version"],"additionalProperties":false},"MediaTypeResponseDto":{"title":"MediaTypeResponseDto","type":"object","properties":{"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}}},"required":["mimeType","extensions"],"additionalProperties":false},"MediaItemsResponseDto":{"title":"MediaItemsResponseDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mediaTypeId":{"type":"string"},"userId":{"type":"string"},"metadata":{"type":"object"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"keywordDetails":{"type":"object"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"scanStatus":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"isFavorite":{"type":"boolean","description":"Provide the isFavorites value to filter the favorite records (e.g true)."},"collectionIds":{"type":"array","items":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"mediaType":{"$ref":"#/components/schemas/MediaTypeResponseDto"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail media storage ID (e.g 892a60f3-7fe9-4e4b-b65c-b8afe5314a33).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"thumbnailFileSize":{"type":"number","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"size":{"type":"number","description":"Specifies the size."},"version":{"type":"number","description":"Specifies the version of the rendition."},"isUnique":{"type":"boolean","description":"Provide the isUnique value to identify the duplicate filename in a collection (e.g. true)."},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"friendlyUrl":{"type":"string","description":"Media Asset Friendly URL"}},"required":["id","name","mediaTypeId","userId","created","updated","scanStatus"],"additionalProperties":false},"MediaItemResponseDto":{"title":"MediaItemResponseDto","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."},"errorMessage":{"type":"string","description":"Operation error message."},"mediaInfo":{"$ref":"#/components/schemas/MediaItemsResponseDto"}},"required":["isSuccess","errorMessage","mediaInfo"],"additionalProperties":false},"MediaReqCreate":{"title":"MediaReqCreate","type":"object","properties":{"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"keywordDetails":{"type":"array","items":{"type":"object","description":"Media asset file keywords."}},"multerFile":{"type":"object","description":"Specifies the file."},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"name":{"type":"string","description":"Specifies the media asset name.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"number","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"number","description":"Specifies the size.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaTypeId":{"type":"string","description":"Provide the media assetType ID (e.g. 26c9ad35-5376-4f79-b391-235c946a9fc2).Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailFileSize":{"type":"number","description":"Specifies the size.Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"sourceMediaId":{"type":"string","description":"Specifies the media asset id to be copied.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"additionalProperties":false},"MediaReq":{"title":"MediaReq","type":"object","properties":{"multerFile":{"type":"object","description":"Specifies the file."},"title":{"type":"string","description":"Media asset file title."},"description":{"type":"string","description":"Media asset file description."},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"keywordDetails":{"type":"array","items":{"type":"object","description":"Media asset file keywords."}},"collectionIds":{"type":"array","items":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the asset has to be moved"},"baseMediaStorageId":{"type":"string","description":"Returns the baseMediaStorage ID (e.g 61ab0552-7391-4336-95ef-700d3a325f37).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"name":{"type":"string","description":"Specifies the media asset name.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the media asset id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userID":{"type":"string","description":"Specifies the media asset user id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media item were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Media asset file description.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"resetKeywords":{"type":"boolean"},"scanStatus":{"type":"string","description":"Specifies Scan status of media item.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"lastScanTime":{"type":"string","description":"Specifies date and time when media item was last scanned.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["multerFile"],"additionalProperties":false},"TotalObjectDto":{"title":"TotalObjectDto","type":"object","properties":{"videos":{"type":"string","description":"Specifies videos count in the collection."},"images":{"type":"string","description":"Specifies images count in the collection."},"documents":{"type":"string","description":"Specifies documents count in the collection."},"collections":{"type":"string","description":"Specifies the collections count in the collection."},"items":{"type":"string","description":"Specifies the total count for items in the collection."}},"additionalProperties":false},"CollectionResponseSelfDto":{"title":"CollectionResponseSelfDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uniqueName":{"type":"string"},"isCustomUniqueName":{"type":"boolean"},"location":{"type":"string"},"userid":{"type":"string"},"parentid":{"type":"string"},"rootparentid":{"type":"string"},"accessreferenceid":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"editable":{"type":"boolean","description":"Specifies the editable permission."},"deletable":{"type":"boolean","description":"Specifies the deletable permission."},"accessible":{"type":"boolean","description":"Specifies any permission."},"total":{"$ref":"#/components/schemas/TotalObjectDto"}},"required":["id","name","uniqueName","created","updated"],"additionalProperties":false},"CollectionReq":{"title":"CollectionReq","type":"object","properties":{"name":{"type":"string","description":"Specifies the name."},"id":{"type":"string","description":"Provide the collectionID. e.g., 069b5892-1b5e-4ef6-bf50-65702267b149.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Specifies the description.","nullable":true},"uniqueName":{"type":"string","description":"Provide the unique collection name for the collection (e.g: unique_collection)."},"isCustomUniqueName":{"type":"boolean","description":"Provide the isCustomUniqueName value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"inheritFromParent":{"type":"boolean","description":"Provide the inheritFromParent value for the collection"},"location":{"type":"string","description":"Provide the location value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"parentid":{"type":"string","description":"Provide the parent ID. e.g., 26c9ad35-5376-4f79-b391-235c946a9fc2."},"rootparentid":{"type":"string"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the collection has to be moved."},"accessreferenceid":{"type":"string","description":"Provide accessreferenceid of the collection e.g., Z1UGeAeGHDI3HL6O9E4JM462BDAMMG65JPCJM8C6BD0JMO6LPD03P86MPD4MOG6P1..
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userid":{"type":"string","description":"Provide the userid of the collection. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time when collections was created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time when collections was updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"permissionDetails":{"type":"object","description":"Permission or access details."}},"required":["name"],"additionalProperties":false},"CollectionReqPartial":{"title":"CollectionReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"name":{"type":"string","description":"Specifies the name."},"id":{"type":"string","description":"Provide the collectionID. e.g., 069b5892-1b5e-4ef6-bf50-65702267b149.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"description":{"type":"string","description":"Specifies the description.","nullable":true},"uniqueName":{"type":"string","description":"Provide the unique collection name for the collection (e.g: unique_collection)."},"isCustomUniqueName":{"type":"boolean","description":"Provide the isCustomUniqueName value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"inheritFromParent":{"type":"boolean","description":"Provide the inheritFromParent value for the collection"},"location":{"type":"string","description":"Provide the location value for the collection.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"parentid":{"type":"string","description":"Provide the parent ID. e.g., 26c9ad35-5376-4f79-b391-235c946a9fc2."},"rootparentid":{"type":"string"},"targetCollectionId":{"type":"string","description":"Specifies the ID of the target collection to which the collection has to be moved."},"accessreferenceid":{"type":"string","description":"Provide accessreferenceid of the collection e.g., Z1UGeAeGHDI3HL6O9E4JM462BDAMMG65JPCJM8C6BD0JMO6LPD03P86MPD4MOG6P1..
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"userid":{"type":"string","description":"Provide the userid of the collection. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time when collections was created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time when collections was updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"permissionDetails":{"type":"object","description":"Permission or access details."}},"additionalProperties":false,"x-typescript-type":"Partial"},"CollectionPath":{"title":"CollectionPath","type":"object","properties":{"name":{"type":"string","description":"Specifies the collection name."},"id":{"type":"string","description":"Provide the collection ID. e.g., 9d415781-6b65-4077-9e09-00e8e11f16b6."}},"additionalProperties":false},"ThumbnailObjectDto":{"title":"ThumbnailObjectDto","type":"object","properties":{"mediaName":{"type":"string","description":"Specifies the media asset name."},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."}},"additionalProperties":false},"CollectionResponseDto":{"title":"CollectionResponseDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uniqueName":{"type":"string"},"isCustomUniqueName":{"type":"boolean"},"location":{"type":"string"},"userid":{"type":"string"},"parentid":{"type":"string"},"rootparentid":{"type":"string"},"accessreferenceid":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"total":{"$ref":"#/components/schemas/TotalObjectDto"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/ThumbnailObjectDto"}},"editable":{"type":"boolean","description":"Specifies the editable permission."},"deletable":{"type":"boolean","description":"Specifies the deletable permission."},"rootaccessreferenceid":{"type":"string","description":"Specifies the access reference id"},"accessible":{"type":"boolean","description":"Specifies any permission."}},"required":["id","name","uniqueName","created","updated"],"additionalProperties":false},"CollectionListResponseDto":{"title":"CollectionListResponseDto","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"paths":{"type":"array","items":{"$ref":"#/components/schemas/CollectionPath"}},"contents":{"type":"array","items":{"$ref":"#/components/schemas/CollectionResponseDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"AssetsReferecesTypeDataDto":{"title":"AssetsReferecesTypeDataDto","type":"object","properties":{"type":{"type":"string","description":"Specifies the asset reference type such as Collection, Component, Content and ContentTemplate."},"data":{"type":"object","description":"Specifies the asset reference details."}},"additionalProperties":false},"AssetReferencesResponse":{"title":"AssetReferencesResponse","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/AssetsReferecesTypeDataDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"RenditionPayloadDto":{"title":"RenditionPayloadDto","type":"object","properties":{"id":{"type":"string","description":"Specifies the ID field of rendition"},"latestVersion":{"type":"number","description":"Specifies the version of the rendition."},"description":{"type":"string","description":"Specifies the actions performed on the version"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"name":{"type":"string","description":"Specifies the name."},"title":{"type":"string","description":"Specifies the title of the media item"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileExtension":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"createdBy":{"type":"string","description":"Specifies who created the rendition"},"updatedBy":{"type":"string","description":"Specifies who modified the rendition"},"created":{"type":"string","format":"date-time","description":"Specifies date and time when renditions were created"},"updated":{"type":"string","format":"date-time","description":"Specifies date and time when renditions were updated"},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail mediastorageid of rendition (e.g. 276504533-a8c3-4f3f-b855-b3253184061c).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"FavoriteRsp":{"title":"FavoriteRsp","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."},"mediaItemId":{"type":"string","description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car."},"message":{"type":"string","description":"Specifies the message."},"created":{"type":"string","description":"Specifies date and time when favorites were created.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."},"updated":{"type":"string","description":"Specifies date and time when favorites were updated.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"required":["isSuccess","mediaItemId","message"],"additionalProperties":false},"FavoriteReq":{"title":"FavoriteReq","type":"object","properties":{"mediaItemIds":{"type":"array","items":{"type":"string","description":"Provide the media asset ID. e.g., 0f06cc1c-bb99-48b3-b8ff-4e5de51b4b54 or media asset name. e.g., car.jpg or custom url. e.g., yellow_car."}},"userId":{"type":"string","description":"Specifies the userID. e.g., wpsadmin.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when favorites were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when favorites were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["mediaItemIds"],"additionalProperties":false},"Favorite":{"title":"Favorite","type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"mediaId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["userId","created","updated"],"additionalProperties":false},"MediaPayload":{"title":"MediaPayload","type":"object","properties":{"id":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"name":{"type":"string"},"userId":{"type":"string"},"size":{"type":"number"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"mediaType":{"$ref":"#/components/schemas/MediaTypeResponseDto"},"metadata":{"type":"object"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"isFavorite":{"type":"boolean","description":"Provide the isFavorites value to filter the favorite records (e.g true)."},"isUnique":{"type":"boolean","description":"Provide the isUnique value to identify the duplicate filename in a collection (e.g. true)."},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"friendlyUrl":{"type":"string","description":"Media Asset Friendly URL"}},"required":["id","created","updated","name","userId","size","self","mediaType","thumbnailUrl","binaryUrl","isFavorite"],"additionalProperties":false},"MediaItemsResponse":{"title":"MediaItemsResponse","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaPayload"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"MediaTypeGroupReq":{"title":"MediaTypeGroupReq","type":"object","properties":{"name":{"type":"string","description":"Specifies the name."},"description":{"type":"string","description":"Specifies the description."},"maxFileSize":{"type":"number","description":"Specifies the size."},"id":{"type":"string","description":"Provides media group type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media type groups were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media type groups were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["name","description","maxFileSize"],"additionalProperties":false},"MediaTypeResponsePayload":{"title":"MediaTypeResponsePayload","type":"object","properties":{"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}},"mediaTypeGroupId":{"type":"string"},"enabled":{"type":"boolean"}},"required":["mimeType","extensions","mediaTypeGroupId"],"additionalProperties":false},"MediaTypeGroupDto":{"title":"MediaTypeGroupDto","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"maxFileSize":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"mediaTypes":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeResponsePayload"}}},"required":["id","name","description","maxFileSize","created","updated"],"additionalProperties":false},"MediaTypeGroupResponse":{"title":"MediaTypeGroupResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeGroupDto"}}},"additionalProperties":false},"MediaTypeGroupReqPartial":{"title":"MediaTypeGroupReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"name":{"type":"string","description":"Specifies the name."},"description":{"type":"string","description":"Specifies the description."},"maxFileSize":{"type":"number","description":"Specifies the size."},"id":{"type":"string","description":"Provides media group type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media type groups were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media type groups were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"additionalProperties":false,"x-typescript-type":"Partial"},"MediaTypeGroup":{"title":"MediaTypeGroup","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"maxFileSize":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["id","name","description","maxFileSize","created","updated"],"additionalProperties":false},"MediaTypeDto":{"title":"MediaTypeDto","type":"object","properties":{"id":{"type":"string"},"mimeType":{"type":"string"},"extensions":{"type":"array","items":{"type":"string"}},"mediaTypeGroupId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"type":{"type":"string","description":"Specifies the media asset type."}},"required":["mimeType","extensions","created","updated"],"additionalProperties":false},"MediaTypeReq":{"title":"MediaTypeReq","type":"object","properties":{"mimeType":{"type":"string","description":"Specifies the media asset type."},"extensions":{"type":"array","items":{"type":"string","description":"Specifies the extensions."}},"mediaTypeGroupId":{"type":"string","description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675)."},"id":{"type":"string","description":"Provides media type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media types were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media types were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"enabled":{"type":"boolean","description":"`true` or `false` should be passed in order to enable or disable the mime type.
"}},"required":["mimeType","extensions"],"additionalProperties":false},"MediaTypesResponse":{"title":"MediaTypesResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/MediaTypeDto"}}},"additionalProperties":false},"MediaTypeReqPartial":{"title":"MediaTypeReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"mimeType":{"type":"string","description":"Specifies the media asset type."},"extensions":{"type":"array","items":{"type":"string","description":"Specifies the extensions."}},"mediaTypeGroupId":{"type":"string","description":"Provide media assetTypeGroup ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675)."},"id":{"type":"string","description":"Provides media type ID (e.g 605b2d27-8767-421b-a941-cf7d0ebc9675).
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies date and time when media types were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies date and time when media types were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"enabled":{"type":"boolean","description":"`true` or `false` should be passed in order to enable or disable the mime type.
"}},"additionalProperties":false,"x-typescript-type":"Partial"},"Operation":{"title":"Operation","type":"object","properties":{"id":{"type":"string"},"triggerFunction":{"type":"string"},"inputs":{"type":"object"},"status":{"type":"string"},"errorInfo":{"type":"object"},"retryCounter":{"type":"number"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"owner":{"type":"number"},"priority":{"type":"number"}},"required":["id","triggerFunction","inputs","status","retryCounter","created","updated"],"additionalProperties":false},"RenditionRequest":{"title":"RenditionRequest","type":"object","properties":{"id":{"type":"string","description":"provide the ID field of rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaItemId":{"type":"string","description":"Provide the media item Id.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"renditionType":{"type":"string","description":"Provide the rendition type, such as desktop, tablet, mobile etc.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"thumbnailMediaStorageId":{"type":"string","description":"Provide the thumbnail media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Provide the date and time to specify when rendition were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Provide the date and time to specify when rendition were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"createdBy":{"type":"string","description":"Provide the info who created rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updatedBy":{"type":"string","description":"Provide the info who updated rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"customUrl":{"type":"string","description":"Media Asset Custom URLNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"string","description":"Provide the file size in bytes. (e.g. 100, 1000)Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"multerFile":{"type":"object","description":"Specifies the file."}},"additionalProperties":false},"MediaRequest":{"title":"MediaRequest","type":"object","properties":{"description":{"type":"string","description":"Specifies the version description"},"actions":{"type":"object","description":"Specifies the action description"},"multerFile":{"type":"object","description":"Specifies the file."},"customUrl":{"type":"string","description":"Media Asset Custom URLNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"id":{"type":"string","description":"Specifies the ID field of version.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"version":{"type":"number","description":"Specifies the version of the rendition.Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"mediaStorageId":{"type":"string","description":"Specifies the media storage ID.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"createdBy":{"type":"string","description":"Specifies who created the rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updatedBy":{"type":"string","description":"Specifies who updated the rendition.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","description":"Specifies the date and time when versions were created.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"updated":{"type":"string","description":"Specifies the date and time when versions were updated.
Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"metadata":{"type":"string","description":"Specifies the metadata of the media item, such as height, width, aspect ratioNote: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"fileSize":{"type":"number","description":"Provide the file size in bytes. (e.g. 100, 1000)Note: Passing parameter will enable operation for staging from database/ different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"removeExistingKeywords":{"type":"boolean","description":"Specifies old keyword retention"},"addNewKeywords":{"type":"boolean","description":"If passed false, new keywords will not be generated for the item."}},"additionalProperties":false},"VersionResponseDetailsDto":{"title":"VersionResponseDetailsDto","type":"object","properties":{"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"id":{"type":"string","description":"Specifies the ID field of version"},"renditionId":{"type":"string","description":"Specifies the ID field of rendition"},"version":{"type":"number","description":"Specifies the version of the rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"description":{"type":"string","description":"Specifies the description of the media item"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"title":{"type":"string","description":"Specifies the title of the media item"},"itemDescription":{"type":"string","description":"Specifies the actions performed on the version"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the mime-type of the media item. e.g., image/jpeg"},"createdBy":{"type":"string","description":"Specifies who created the version"},"updatedBy":{"type":"string","description":"Specifies who modified the version"},"created":{"type":"string","description":"Specifies date and time when versions were created"},"updated":{"type":"string","description":"Specifies date and time when versions were updated"},"mediaStorageId":{"type":"string","description":"Specifies the ID field of media storage.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"VersionListResponseDto":{"title":"VersionListResponseDto","type":"object","properties":{"offset":{"type":"number","description":"Provide the offset for pagination (e.g. 0)."},"limit":{"type":"number","description":"Provide the number of records to be fetched for pagination (e.g. 10)."},"total":{"type":"number","description":"Total number of records available."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"first":{"type":"string","description":"Specifies the url to navigate to first page as per current queries."},"prev":{"type":"string","description":"Specifies the url to navigate to previous page as per current queries."},"next":{"type":"string","description":"Specifies the url to navigate to next page as per current queries."},"last":{"type":"string","description":"Specifies the url to navigate to last page as per current queries."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/VersionResponseDetailsDto"}}},"required":["offset","limit","total","self","first","prev","next","last"],"additionalProperties":false},"VersionPayloadDto":{"title":"VersionPayloadDto","type":"object","properties":{"id":{"type":"string","description":"Provide the version ID. e.g., 0j06cc1c-bb99-48b3-b8ff-4e5de51b4b59 or version number. e.g., 1."},"version":{"type":"number","description":"Specifies the version of the rendition."},"description":{"type":"string","description":"Specifies the actions performed on the version"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"name":{"type":"string","description":"Specifies the name."},"title":{"type":"string","description":"Specifies the title of the media item"},"itemDescription":{"type":"string","description":"Specifies the actions performed on the version"},"keywords":{"type":"array","items":{"type":"string","description":"Media asset file keywords."}},"fileExtension":{"type":"string","description":"Provide the file extensions without prefixing dot(.) such as png, jpeg, jpg and etc."},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"mimeType":{"type":"string","description":"Specifies the media asset type."},"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"createdBy":{"type":"string","description":"Specifies who created the version"},"updatedBy":{"type":"string","description":"Specifies who modified the version"},"created":{"type":"string","format":"date-time","description":"Specifies date and time when versions were created"},"updated":{"type":"string","format":"date-time","description":"Specifies date and time when versions were updated"},"mediaStorageId":{"type":"string","description":"Specifies the ID field of media storage.
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"RenditionTypeResponseDto":{"title":"RenditionTypeResponseDto","type":"object","properties":{"self":{"type":"string","description":"Specifies the current url where data has been fetched."},"id":{"type":"string","description":"Specifies the ID field of rendition"},"renditionType":{"type":"string","description":"Specifies the type of rendition, such as desktop, tablet, mobile etc"},"thumbnailUrl":{"type":"string","description":"Specifies the URL to get the binary data for thumbnail of the original rendition."},"binaryUrl":{"type":"string","description":"Specifies the URL to get the binary data for the latest version of the original rendition."},"mimeType":{"type":"string","description":"Specifies the mime-type of the media item. e.g., image/jpeg"},"fileSize":{"type":"number","description":"Specifies the size."},"metadata":{"type":"object","description":"Specifies the metadata of the media item, such as height, width, aspect ratio"},"createdBy":{"type":"string","description":"Specifies who created the rendition"},"updatedBy":{"type":"string","description":"Specifies who modified the rendition"},"created":{"type":"string","description":"Specifies date and time when renditions were created"},"updated":{"type":"string","description":"Specifies date and time when renditions were updated"},"customUrl":{"type":"string","description":"Media Asset Custom URL"},"thumbnailMediaStorageId":{"type":"string","description":"Returns the thumbnail mediastorageid of rendition (e.g. 276504533-a8c3-4f3f-b855-b3253184061c).
Note: Only Admin will get response for this parameter. Non-Admin Users will get no response for this parameter."}},"additionalProperties":false},"RenditionListResponse":{"title":"RenditionListResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/RenditionTypeResponseDto"}}},"additionalProperties":false},"Schema":{"title":"Schema","type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"status":{"type":"string"}},"required":["name","version","status"],"additionalProperties":false},"SchemaContentResponse":{"title":"SchemaContentResponse","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}}},"additionalProperties":false},"ReindexingResponseDto":{"title":"ReindexingResponseDto","type":"object","properties":{"status":{"type":"string","description":"Speacifies successful initiate search reindexing"}},"required":["status"],"additionalProperties":false},"SubscriberRegistrationResponseDto":{"title":"SubscriberRegistrationResponseDto","type":"object","properties":{"id":{"type":"string"},"targetHost":{"type":"string"},"syncStatus":{"type":"string"},"syncFailureLogs":{"type":"string"},"lastSyncTime":{"type":"string","format":"date-time"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"isSuccess":{"type":"boolean","description":"Operation success status."},"errorMessage":{"type":"string","description":"Operation error message."}},"required":["id","targetHost","status","created","updated","isSuccess","errorMessage"],"additionalProperties":false},"SubscriberRegistrationReq":{"title":"SubscriberRegistrationReq","type":"object","properties":{"targetHost":{"type":"string"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"lastSyncTime":{"type":"string","format":"date-time"},"syncStatus":{"type":"string"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"syncFailureLogs":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["targetHost"],"additionalProperties":false},"SubscriberRegistration":{"title":"SubscriberRegistration","type":"object","properties":{"id":{"type":"string"},"targetHost":{"type":"string"},"syncStatus":{"type":"string"},"syncFailureLogs":{"type":"string"},"lastSyncTime":{"type":"string","format":"date-time"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["id","targetHost","status","created","updated"],"additionalProperties":false},"SubscriberRegistrationReqPartial":{"title":"SubscriberRegistrationReqPartial","type":"object","description":"(tsType: Partial, schemaOptions: { partial: true })","properties":{"targetHost":{"type":"string"},"cycleLength":{"type":"number"},"status":{"type":"boolean"},"lastSyncTime":{"type":"string","format":"date-time"},"syncStatus":{"type":"string"},"resyncStatus":{"type":"string"},"lastResyncTime":{"type":"string","format":"date-time"},"syncFailureLogs":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"additionalProperties":false,"x-typescript-type":"Partial"},"HashResponseDto":{"title":"HashResponseDto","type":"object","properties":{"hash":{"type":"string","description":"Specify the hash for range of records.
"},"count":{"type":"number","description":"Specify the count for number of records for which hash been generated.
"},"id":{"type":"string","description":"Specify the id for individual record for which hash been generated.
"}},"required":["hash","count","id"],"additionalProperties":false},"RecordHashDto":{"title":"RecordHashDto","type":"object","properties":{"id":{"type":"string","description":"Specify the id for individual record for which hash been generated.
"},"hash":{"type":"string","description":"Specify the hash for range of records.
"}},"required":["id","hash"],"additionalProperties":false},"HashListResponseDto":{"title":"HashListResponseDto","type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/RecordHashDto"}}},"additionalProperties":false},"StagingRecordDetailsResponseDto":{"title":"StagingRecordDetailsResponseDto","type":"object","properties":{"collection":{"type":"object"},"mediaItem":{"type":"object"},"rendition":{"type":"object"},"version":{"type":"object"},"customUrl":{"type":"object"},"keyword":{"type":"object"},"mediaType":{"type":"object"},"mediaTypeGroup":{"type":"object"},"resourceId":{"type":"string"},"permission":{"type":"array","items":{"type":"object"}}},"additionalProperties":false},"SubscriberInterfaceResponseDto":{"title":"SubscriberInterfaceResponseDto","type":"object","properties":{"isSuccess":{"type":"boolean","description":"Operation success status."}},"required":["isSuccess"],"additionalProperties":false},"SubscriberInterfaceReq":{"title":"SubscriberInterfaceReq","type":"object","properties":{"eventData":{"type":"object","description":"Specifies the event data.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"host":{"type":"string","description":"Specifies the host.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"type":{"type":"string","description":"Specifies the event type.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"action":{"type":"string","description":"Specifies the event actions. (e.g. CREATE, UPDATE, DELETE)
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."},"created":{"type":"string","format":"date-time","description":"Provide the date and time to specify when event data were created.
Note: Passing parameter will enable operation for staging from different environment. Only admin will be able to pass the parameter. Avoid adding any value for parameter if you are not aware of its implementation."}},"required":["eventData","host","type","action","created"],"additionalProperties":false}},"securitySchemes":{"cookieAuth":{"description":"LtpaToke2 is going to identifying the user session.","type":"apiKey","in":"cookie","name":"LtpaToken2"}}},"servers":[{"url":"/dx/api/dam/v1"}]} \ No newline at end of file diff --git a/image-processor-api/openapi.json b/image-processor-api/openapi.json index d704ba0..20c465e 100644 --- a/image-processor-api/openapi.json +++ b/image-processor-api/openapi.json @@ -1 +1 @@ -{"openapi":"3.0.3","info":{"version":"1.36.0","title":"image-processor API","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX"},"paths":{"/dx/api/image-processor/v1/images/resize":{"post":{"operationId":"imagesControllerResize","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"height":{"type":"number"},"width":{"type":"number"},"scale":{"type":"number"},"keepaspectratio":{"type":"string"},"scaleup":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/crop":{"post":{"operationId":"imagesControllerCrop","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"description":"This endpoint returns cropped image based on the top left x,y and bottom right x,y coordinates or the specific region","parameters":[],"requestBody":{"required":true,"description":"The actual image to be cropped","content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"topLeftX":{"type":"number"},"topLeftY":{"type":"number"},"bottomRightX":{"type":"number"},"bottomRightY":{"type":"number"},"region":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/rotate":{"post":{"operationId":"imagesControllerRotate","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"rotation":{"type":"number"},"background":{"type":"object"}},"type":"object","required":["file","rotation"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/transparency":{"post":{"operationId":"imagesControllerTransparency","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"opacity":{"type":"number"}},"type":"object","required":["file","opacity"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/convert":{"post":{"operationId":"imagesControllerConvert","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"fileType":{"type":"string","minLength":1}},"type":"object","required":["file","fileType"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/flip":{"post":{"operationId":"imagesControllerFlip","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"vertical":{"type":"boolean"},"horizontal":{"type":"boolean"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/getMetaData":{"post":{"operationId":"imagesControllerGetMetaData","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/config":{"get":{"operationId":"mimeTypeControllerGetMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/images":{"get":{"operationId":"mimeTypeControllerGetImagesMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/videos":{"get":{"operationId":"mimeTypeControllerGetVideosMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/documents":{"get":{"operationId":"mimeTypeControllerGetDocumentsMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/plugin/{action}":{"post":{"operationId":"pluginControllerPerformAction","responses":{"202":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"callBackURL":{"type":"string","minLength":1},"actionParams":{"type":"object"}},"type":"object","required":["file","callBackURL"]}}}},"tags":["PluginController"]}}},"tags":[{"name":"ImagesController"},{"name":"MimeTypeController"},{"name":"PluginController"}],"components":{"schemas":{"BadRequest":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1,"example":"BAD_REQUEST","default":"BAD_REQUEST"},"message":{"type":"string","description":"An error message","minLength":1},"status":{"type":"number","description":"The status code of the exception","example":400,"default":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericError"},"description":"A list of related errors"},"stack":{"type":"string","description":"The stack trace (only in development mode)"}},"required":["name","message","status"]},"GenericError":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1},"message":{"type":"string","description":"An error message","minLength":1}},"additionalProperties":true,"required":["name","message"]}}}} \ No newline at end of file +{"openapi":"3.0.3","info":{"version":"1.37.0","title":"image-processor API","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX"},"paths":{"/dx/api/image-processor/v1/images/resize":{"post":{"operationId":"imagesControllerResize","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"height":{"type":"number"},"width":{"type":"number"},"scale":{"type":"number"},"keepaspectratio":{"type":"string"},"scaleup":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/crop":{"post":{"operationId":"imagesControllerCrop","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"description":"This endpoint returns cropped image based on the top left x,y and bottom right x,y coordinates or the specific region","parameters":[],"requestBody":{"required":true,"description":"The actual image to be cropped","content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"topLeftX":{"type":"number"},"topLeftY":{"type":"number"},"bottomRightX":{"type":"number"},"bottomRightY":{"type":"number"},"region":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/rotate":{"post":{"operationId":"imagesControllerRotate","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"rotation":{"type":"number"},"background":{"type":"object"}},"type":"object","required":["file","rotation"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/transparency":{"post":{"operationId":"imagesControllerTransparency","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"opacity":{"type":"number"}},"type":"object","required":["file","opacity"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/convert":{"post":{"operationId":"imagesControllerConvert","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"fileType":{"type":"string","minLength":1}},"type":"object","required":["file","fileType"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/flip":{"post":{"operationId":"imagesControllerFlip","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"vertical":{"type":"boolean"},"horizontal":{"type":"boolean"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/getMetaData":{"post":{"operationId":"imagesControllerGetMetaData","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/config":{"get":{"operationId":"mimeTypeControllerGetMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/images":{"get":{"operationId":"mimeTypeControllerGetImagesMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/videos":{"get":{"operationId":"mimeTypeControllerGetVideosMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/documents":{"get":{"operationId":"mimeTypeControllerGetDocumentsMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/plugin/{action}":{"post":{"operationId":"pluginControllerPerformAction","responses":{"202":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"parameters":[{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"callBackURL":{"type":"string","minLength":1},"actionParams":{"type":"object"}},"type":"object","required":["file","callBackURL"]}}}},"tags":["PluginController"]}}},"tags":[{"name":"ImagesController"},{"name":"MimeTypeController"},{"name":"PluginController"}],"components":{"schemas":{"BadRequest":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1,"example":"BAD_REQUEST","default":"BAD_REQUEST"},"message":{"type":"string","description":"An error message","minLength":1},"status":{"type":"number","description":"The status code of the exception","example":400,"default":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericError"},"description":"A list of related errors"},"stack":{"type":"string","description":"The stack trace (only in development mode)"}},"required":["name","message","status"]},"GenericError":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1},"message":{"type":"string","description":"An error message","minLength":1}},"additionalProperties":true,"required":["name","message"]}}}} \ No newline at end of file diff --git a/pzn-api/openapi.json b/pzn-api/openapi.json index 5c87804..110e223 100644 --- a/pzn-api/openapi.json +++ b/pzn-api/openapi.json @@ -234,7 +234,7 @@ "created": "2022-02-07T07:09:49.191Z", "lastModified": "2022-02-07T07:09:49.191Z", "parentId": "_6QR_0048AAQUGF0A1T2A_18L" - }, + } ] } }, @@ -1247,7 +1247,7 @@ "visibility": "Field to add 'show' or 'hide' if the 'conditions' are met.", "otherwise": "Field to add 'show' or 'hide' if the 'conditions' are not met.", "caseInsensitive": "Boolean indication that the string comparisons in the rule should be case insensitive.", - "conditions": "List of conditions to meet the visibility rule criteria.", + "conditions": "List of conditions to meet the visibility rule criteria." } }, "Profiler":{ @@ -1750,8 +1750,8 @@ "lastModifier": "Filed to indicate that details of the user who is last modified the rule.", "parentId" : "Field to indicate to find the difference between the location of the rule.", "conditions": "List of conditions to meet the select action rule criteria.", - "select": "Field to indicate type of select action rule.", - }, + "select": "Field to indicate type of select action rule." + } }, "Binding Example 1: Simple":{ "value":{ @@ -2087,7 +2087,7 @@ } } } - }, + } }, "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "For success case, API returns list of rules from specified inputs." }, @@ -2819,7 +2819,7 @@ "visibility": "Field to add 'show' or 'hide' if the 'conditions' are met.", "otherwise": "Field to add 'show' or 'hide' if the 'conditions' are not met.", "caseInsensitive": "Boolean indication that the string comparisons in the rule should be case insensitive.", - "conditions": "List of conditions to meet the visibility rule criteria.", + "conditions": "List of conditions to meet the visibility rule criteria." } }, "Profiler": { @@ -2950,7 +2950,7 @@ "lastModifier": "Filed to indicate that details of the user who is last modified the rule.", "parentId" : "Field to indicate to find the difference between the location of the rule.", "conditions": "List of conditions to meet the select action rule criteria.", - "select": "Field to indicate type of select action rule.", + "select": "Field to indicate type of select action rule." } }, "Binding Simple - Sample 1": { @@ -3489,7 +3489,7 @@ "visibility": "Field to add 'show' or 'hide' if the 'conditions' are met.", "otherwise": "Field to add 'show' or 'hide' if the 'conditions' are not met.", "caseInsensitive": "Boolean indication that the string comparisons in the rule should be case insensitive.", - "conditions": "List of conditions to meet the visibility rule criteria.", + "conditions": "List of conditions to meet the visibility rule criteria." } }, "Profiler": { @@ -3724,7 +3724,7 @@ "lastModifier": "Filed to indicate that details of the user who is last modified the rule.", "parentId" : "Field to indicate to find the difference between the location of the rule.", "conditions": "List of conditions to meet the select action rule criteria.", - "select": "Field to indicate type of select action rule.", + "select": "Field to indicate type of select action rule." } }, "Binding":{ @@ -4253,7 +4253,7 @@ "visibility": "Field to add 'show' or 'hide' if the 'conditions' are met.", "otherwise": "Field to add 'show' or 'hide' if the 'conditions' are not met.", "caseInsensitive": "Boolean indication that the string comparisons in the rule should be case insensitive.", - "conditions": "List of conditions to meet the visibility rule criteria.", + "conditions": "List of conditions to meet the visibility rule criteria." } }, "Profiler": { @@ -4370,7 +4370,7 @@ "lastModifier": "Filed to indicate that details of the user who is last modified the rule.", "parentId" : "Field to indicate to find the difference between the location of the rule.", "conditions": "List of conditions to meet the select action rule criteria.", - "select": "Field to indicate type of select action rule.", + "select": "Field to indicate type of select action rule." } }, "Binding Simple - Sample 1": { @@ -4858,7 +4858,7 @@ "ruleId": "Field to indicate rule-id of rule.", "title": "Field to indicate title of rule.", "ruleType": "Field to indicate type of rule.", - "result": "Field to indicate result as show/hide after invoking Visibility rule.", + "result": "Field to indicate result as show/hide after invoking Visibility rule." } }, "Profiler": { @@ -5067,7 +5067,7 @@ } } } - }, + } }, "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "For the success case, the API returns List of dynamic properties." }, diff --git a/ring-api/openapi.json b/ring-api/openapi.json index d112d64..08bd155 100644 --- a/ring-api/openapi.json +++ b/ring-api/openapi.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Ring API","version":"1.36.0","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to HCL DX 9.5 core platform capabilities.","contact":{}},"paths":{"/access/permissions":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"permissions","tags":["AccessControlController"],"operationId":"addAccessPermissions","security":[{"cookieAuth":[]}],"description":"This request creates a new permission.","responses":{"200":{"description":"Returns a newly created permission.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The ID of the type. (e.g., user, group, virtual). Note: This is a required parameter","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"permissionList":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"example":"uid=userId,o=defaultWIMFileBasedRealm","type":"string"}}}}}},"example":{"permissionList":[{"distinguishedName":"uid=userId,o=defaultWIMFileBasedRealm"}]}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":5}}},"/access/principals/{principal_id}":{"delete":{"x-controller-name":"AccessControlController","x-operation-name":"removePrincipal","tags":["AccessControlController"],"operationId":"accessDeletePrincipal","security":[{"cookieAuth":[]}],"description":"This request deletes a principal.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"principal_id","in":"path","description":"The ID of the principal (user or group). (e.g., 8eAe13RO6G4CL3TGMIPDKBQ6MGHE53P02OTDI3T26M14LRSA6PDE)","schema":{"type":"string"},"required":true}]}},"/access/principals":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"addPrincipal","tags":["AccessControlController"],"operationId":"accessAddPrincipal","security":[{"cookieAuth":[]}],"description":"This request assigns the anonymous user to the specified user role.","responses":{"200":{"description":"Returns the newly created principal.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"role":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}}]}},"/access/resources/config":{"put":{"x-controller-name":"AccessControlController","x-operation-name":"modifyResourceConfig","tags":["AccessControlController"],"operationId":"accessUpdateResourceConfig","security":[{"cookieAuth":[]}],"description":"This request updates the access control configuration.","responses":{"200":{"description":"Returns the configuration of a resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"config":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"roleBlock":{"type":"object","properties":{"type":{"type":"string"},"role":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Specify one of the following values: merge to add role blocks to existing ones. The owner is changed if you specify this value. update to replace existing role blocks and owners. The role blocks and owners are removed if you do not specify them. Update is the default value.","schema":{"type":"string","enum":["update","merge"],"example":"update","default":"update"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ownerId":{"example":"Z9eAe1JRU6N5FDRRANP14GRR47Q5CC38ANPLCI3","type":"string"},"roleBlock":{"type":"array","items":{"type":"object","properties":{"type":{"example":"propagation","type":"string"},"role":{"example":"User","type":"string"}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}}},"/anonymous-resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getAnonymousResources","tags":["ResourceController"],"operationId":"getAnonymousResources","security":[{"cookieAuth":[]}],"description":"This request returns all anonymous resources.","responses":{"200":{"description":"Returns all anonymous resources.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"}]}},"/auth/custom-login":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"custHeadLogin","tags":["AuthenticationController"],"operationId":"authCustomLogin","description":"This request authenticates the user by sending the Cookie header content.","responses":{"200":{"description":"Authenticates the user, sends back new access token in the Cookie, returns login success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}]}},"/auth/login":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"login","tags":["AuthenticationController"],"operationId":"authLogin","description":"This request authenticates the user with username and password.","responses":{"200":{"description":"Authenticates the user, sends new access token in the Cookie, returns login success message.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"example":{"username":"","password":""}}},"description":"Replace the placeholders with your own username and password.","x-parameter-index":1}}},"/auth/logout":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"logout","tags":["AuthenticationController"],"operationId":"authLogout","description":"This request deauthenticates the user.","responses":{"200":{"description":"Deauthenticates the user.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"data":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}]}},"/auth/validate":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"validateLogin","tags":["AuthenticationController"],"operationId":"authValidateLogin","security":[{"cookieAuth":[]}],"description":"This request validates if the user is still authenticated.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}]}},"/resources/{resource_id}":{"post":{"x-controller-name":"ResourceController","x-operation-name":"registerResource","tags":["ResourceController"],"operationId":"registerResource","security":[{"cookieAuth":[]}],"description":"This request sets an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"example":"parentExternalId","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. Note: Value of parent should be \"null\" for top-level resources.","x-parameter-index":3}},"put":{"x-controller-name":"ResourceController","x-operation-name":"updateResource","tags":["ResourceController"],"operationId":"updateResource","security":[{"cookieAuth":[]}],"description":"This request sets an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"example":"parentExternalId","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. Note: Value of parent should be \"null\" for top-level resources.","x-parameter-index":3}},"get":{"x-controller-name":"ResourceController","x-operation-name":"getResourceById","tags":["ResourceController"],"operationId":"getResourceById","security":[{"cookieAuth":[]}],"description":"This request returns a resource's details.","responses":{"200":{"description":"Returns the resource details.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}]},"delete":{"x-controller-name":"ResourceController","x-operation-name":"deregisterResource","tags":["ResourceController"],"operationId":"deregisterResource","security":[{"cookieAuth":[]}],"description":"This request removes an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}]}},"/resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getResources","tags":["ResourceController"],"operationId":"getResource","security":[{"cookieAuth":[]}],"description":"This request returns all the resources.","responses":{"200":{"description":"Returns all the resource.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"}]}},"/user-management/attributes/{attribute_name}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getSearchAttributes","tags":["UserManagementController"],"operationId":"getSearchAttributes","security":[{"cookieAuth":[]}],"description":"This request returns the user or user group's attributes.","responses":{"200":{"description":"Returns the user or user group's attributes","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"attribute_name","in":"path","description":"Get all the attributes by users/groups.","examples":{"users":{"value":"users","summary":"Return all attributes defined under the \"users\" profile type"},"usersHomeAddress":{"value":"users/homeAddress","summary":"Return details of the \"homeAddress\" attribute defined under the \"users\" profile type"},"groups":{"value":"groups","summary":"Return all attributes defined under the \"groups\" profile type"},"groupsEntitlementInfo":{"value":"groups/entitlementInfo","summary":"Return details of the \"entitlementInfo\" attribute defined under the \"groups\" profile type"}},"schema":{"type":"string"},"required":true}]}},"/user-management/groups/{group_id}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getGroup","tags":["UserManagementController"],"operationId":"getGroup","security":[{"cookieAuth":[]}],"description":"This request returns a group's details.","responses":{"200":{"description":"Returns group details.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"id":{"type":"string"},"updated":{"type":"string"},"content":{"type":"object","properties":{"profile":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"},"attribute":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"multiValued":{"type":"string"},"attributeValue":{"type":"string"}}}}}}}}}},"example":{"title":"cn=wpsadmins,o=defaultWIMFileBasedRealm","id":"Z8eAe63P66JP6OPCCMM07L9CEJMG6GHP2JM07I9D8MMCC6RDG3O07J1E46SKCG1","updated":"2020-09-14T16:36:33.220Z","content":{"profile":{"type":"group","identifier":"uid=wpsadmin,o=defaultWIMFileBasedRealm","attribute":[{"name":"cn","type":"string","multiValued":"false","attributeValue":"wpsadmin"},{"name":"createTimestamp","type":"dateTime","multiValued":"false","attributeValue":"Sat Sep 05 10:49:09 GMT 2020"}]}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"group_id","in":"path","description":"Group's identifier","schema":{"type":"string"},"required":true},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}}]}},"/user-management/groups":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getGroups","tags":["UserManagementController"],"operationId":"getUsergroup","security":[{"cookieAuth":[]}],"description":"This request returns all user groups.","responses":{"200":{"description":"Returns all of the user groups.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","example":1},"list":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"wpsadmins"},"distinguishedName":{"type":"string","example":"cn=wpsadmins,o=defaultWIMFileBasedRealm"},"id":{"type":"string","example":"Z8eAeIHP0JO06OHP8MM47IPD0JMG6M1E2MM471BC4JMGCK1CC6JPCM9C83O06I1"},"updated":{"type":"string","example":"2020-08-26T20:21:00.166Z"},"profile":{"type":"object","properties":{"identifier":{"type":"string","example":"cn=wpsadmins,o=defaultWIMFileBasedRealm"},"type":{"type":"string","example":"group"},"attributes":{"type":"object","properties":{"identifier":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Z8eAeIHP0JO06OHP8MM47IPD0JMG6M1E2MM471BC4JMGCK1CC6JPCM9C83O06I1"}}},"viewIdentifiers":{"type":"object","properties":{"type":{"type":"string","example":"ViewIdentifierType"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text value"}}},"children":{"type":"object","properties":{"type":{"type":"string","example":"Entity"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text value"}}},"displayName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample display name"}}},"businessCategory":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample business category"}}},"description":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample description"}}},"cn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmins"}}},"partyRoles":{"type":"object","properties":{"type":{"type":"string","example":"PartyRole"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"samplerole"}}},"createTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Fri Aug 11 01:30:30 GMT 2020"}}},"modifyTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Fri Aug 11 01:30:30 GMT 2020"}}}}}}}}}},"index":{"type":"number","example":1},"limit":{"type":"number","example":50},"range":{"type":"string","example":"1-1/1"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","default":1},"description":"The offset attribute of user/group search list. This specifies the offset of the first item in a collection to be returned."},{"name":"limit","in":"query","schema":{"type":"integer","default":4500},"description":"The limit attribute of user/group search list. This constrains the number of items-per-page in a collection returned by a request."},{"name":"filterAttr","in":"query","description":"The filter attribute of user/group search list.","schema":{"type":"string"}},{"name":"filterVal","in":"query","description":"The filter value of user/group search list.","schema":{"type":"string"}},{"name":"memberOf","in":"query","description":"The member of value in user/group search list.","schema":{"type":"string"}},{"name":"expandRefs","in":"query","description":"Boolean value that determines if the complete profiles are embedded in the references.","schema":{"type":"boolean"}},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortByAttributes","in":"query","description":"List of attribute names that specifies the sort order for the results. This is only supported for a paged search.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"descending","in":"query","description":"Boolean value that determines if the sort direction for attributes will be descending. This is based on the sequence of attributes in sortByAttributes.","schema":{"type":"boolean"}}]}},"/user-management/users/{user_id}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getUser","tags":["UserManagementController"],"operationId":"getUser","security":[{"cookieAuth":[]}],"description":"This request returns a user's details.","responses":{"200":{"description":"Returns user detail.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"id":{"type":"string"},"updated":{"type":"string"},"content":{"type":"object","properties":{"profile":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"},"attribute":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"multiValued":{"type":"string"},"attributeValue":{"type":"string"}}}}}}}}}},"example":{"title":"uid=wpsadmin,o=defaultWIMFileBasedRealm","id":"Z9eAe1BPAMIH6MHC4JMG6M9EAJMG6H9ECJM8CIHC6MM464BD46SO62JC8JO46G1","updated":"2020-09-14T16:36:33.220Z","content":{"profile":{"type":"user","identifier":"uid=wpsadmin,o=defaultWIMFileBasedRealm","attribute":[{"name":"uid","type":"string","multiValued":"false","attributeValue":"wpsadmin"},{"name":"createTimestamp","type":"dateTime","multiValued":"false","attributeValue":"Sat Sep 05 10:49:09 GMT 2020"}]}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User's identifier","schema":{"type":"string"},"required":true},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}}]}},"/user-management/users":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getUsers","tags":["UserManagementController"],"operationId":"getUsers","security":[{"cookieAuth":[]}],"description":"This request returns all users.","responses":{"200":{"description":"Returns all users.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","example":5},"list":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"Z9eAe13E8JIPCJ1DCMM07OPOAMMG6KHCGJM47K9CGJMK6H1P63HT6GPC83SC6L1"},"name":{"type":"string","example":"wpsadmin"},"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"updated":{"type":"string","example":"2020-08-11T00:30:42.080Z"},"profile":{"type":"object","properties":{"identifier":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"type":{"type":"string","example":"user"},"attributes":{"type":"object","properties":{"preferredLanguage":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"en"}}},"roomNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"103"}}},"telephoneNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"displayName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"ibm-jobTitle":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample job title"}}},"postalCode":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"27609"}}},"description":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample description text"}}},"title":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text"}}},"carLicense":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"S123-456-78-901-0"}}},"seeAlso":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample reference text"}}},"createTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Thu Aug 11 01:30:30 GMT 2020"}}},"uid":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"localityName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample locality text"}}},"secretary":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"true"}}},"viewIdentifiers":{"type":"object","properties":{"type":{"type":"string","example":"ViewIdentifierType"},"multiValued":{"type":"string","example":"true"}}},"pager":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"children":{"type":"object","properties":{"type":{"type":"string","example":"Entity"},"multiValued":{"type":"string","example":"true"}}},"street":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Saunders Street"}}},"sn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"businessAddress":{"type":"object","properties":{"type":{"type":"string","example":"AddressType"},"multiValued":{"type":"string","example":"true"}}},"homeAddress":{"type":"object","properties":{"type":{"type":"string","example":"AddressType"},"multiValued":{"type":"string","example":"true"}}},"jpegPhoto":{"type":"object","properties":{"type":{"type":"string","example":"xs:hexBinary"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"FFD8FFE000104A46494600010100004800480000FFE10FFD8FFE000104A46494600010100004800480000FFE10FFD8FFE000104A46494600010100004800480000FFE1000480000FFE10FFD8FFE0"}}},"st":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample st value"}}},"c":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample c value"}}},"manager":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"true"}}},"initials":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"JS"}}},"givenName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"mobile":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"groups":{"type":"object","properties":{"type":{"type":"string","example":"Group"},"multiValued":{"type":"string","example":"true"}}},"cn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"facsimileTelephoneNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"l":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample value"}}},"homePostalAddress":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"partyRoles":{"type":"object","properties":{"type":{"type":"string","example":"PartyRole"},"multiValued":{"type":"string","example":"true"}}},"stateOrProvinceName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"North Carolina"}}},"postalAddress":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"200 Crossroads Blvd"}}},"departmentNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"S-100"}}},"businessCategory":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample category"}}},"countryName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"US"}}},"mail":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"200 Crossroads Blvd"}}},"employeeNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"E-123456"}}},"modifyTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Mon Aug 11 00:30:42 GMT 2020"}}},"ibm-primaryEmail":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"username@email.com"}}},"labeledURI":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"/sample/uri"}}},"kerberosId":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"ADAPWS/sample"}}}}}}}}}},"index":{"type":"number","example":1},"limit":{"type":"number","example":50},"range":{"type":"string","example":"1-5/5"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","default":1},"description":"The offset attribute of user/group search list. This specifies the offset of the first item in a collection to be returned."},{"name":"limit","in":"query","schema":{"type":"integer","default":4500},"description":"The limit attribute of user/group search list. This constrains the number of items-per-page in a collection returned by a request."},{"name":"filterAttr","in":"query","description":"The filter attribute of user/group search list.","schema":{"type":"string"}},{"name":"filterVal","in":"query","description":"The filter value of user/group search list.","schema":{"type":"string"}},{"name":"memberOf","in":"query","description":"The member of value in user/group search list.","schema":{"type":"string"}},{"name":"expandRefs","in":"query","description":"Boolean value that determines if the complete profiles are embedded in the references.","schema":{"type":"boolean"}},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortByAttributes","in":"query","description":"List of attribute names that specifies the sort order for the results. This is only supported for a paged search.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"descending","in":"query","description":"Boolean value that determines if the sort direction for attributes will be descending. This is based on the sequence of attributes in sortByAttributes.","schema":{"type":"boolean"}}]}},"/webcontent/components/{component_id}":{"put":{"x-controller-name":"ComponentController","x-operation-name":"update","tags":["ComponentController"],"operationId":"webContentUpdateComponent","security":[{"cookieAuth":[]}],"description":"This request updates a component.","responses":{"200":{"description":"Returns the updated component details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component.","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"My Updated Title"},"content":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"This is Some HTML Text"}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}},"delete":{"x-controller-name":"ComponentController","x-operation-name":"delete","tags":["ComponentController"],"operationId":"webContentDeleteComponent","security":[{"cookieAuth":[]}],"description":"This request deletes a component.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component. (See example below)","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}]}},"/webcontent/components":{"post":{"x-controller-name":"ComponentController","x-operation-name":"create","tags":["ComponentController"],"operationId":"webContentAddComponent","security":[{"cookieAuth":[]}],"description":"This request creates a new component.","responses":{"200":{"description":"Returns the newly created component.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_type","in":"query","description":"The type of the component.","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","example":"20e55d82-3ff9-40aa-acb3-e0eeddc45ea8"},"name":{"type":"string","example":"MyHTMLComponent"},"title":{"type":"string","example":"My HTML Component"},"content":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"

This is some rich text

\n"}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/configuration/{content_id}/version/{version_number}":{"put":{"x-controller-name":"ContentConfigurationController","x-operation-name":"restoreVersionNumber","tags":["ContentConfigurationController"],"operationId":"contentConfigRestoreItemVersionDetails","security":[{"cookieAuth":[]}],"description":"This request restores a content to a specified version.","responses":{"200":{"description":"Returns the restored content at a specified version number.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["id","title","displayTitle","titleTextProviderName","titleTextProviderKey","summary","versionContent","name","type","updated","created","lastModifier","creator","category","content"],"properties":{"id":{"type":"string","title":"The Id Schema","default":"","pattern":"^(.*)$"},"title":{"type":"object","title":"The Title Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"displayTitle":{"type":"object","title":"The Displaytitle Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"titleTextProviderName":{"type":"string","title":"The Titletextprovidername Schema","default":"","pattern":"^(.*)$"},"titleTextProviderKey":{"type":"string","title":"The Titletextproviderkey Schema","default":"","pattern":"^(.*)$"},"summary":{"type":"object","title":"The Summary Schema","required":["lang"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}},"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"},"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"updated":{"type":"string","title":"The Updated Schema","default":"","pattern":"^(.*)$"},"created":{"type":"string","title":"The Created Schema","default":"","pattern":"^(.*)$"},"lastModifier":{"type":"object","title":"The Lastmodifier Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"creator":{"type":"object","title":"The Creator Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"category":{"type":"array","title":"The Category Schema","items":{"type":"object","title":"The Items Schema","required":["scheme","term","label","lang"],"properties":{"scheme":{"type":"string","title":"The Scheme Schema","default":"","pattern":"^(.*)$"},"term":{"type":"string","title":"The Term Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}}},"content":{"type":"object","title":"The Content Schema","required":["type","value"],"properties":{"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"version_number","in":"path","description":"The version number of the web content item.","schema":{"type":"number"},"required":true},{"name":"publish","in":"query","description":"Boolean value to determine if published or not","schema":{"type":"boolean"}}]},"get":{"x-controller-name":"ContentConfigurationController","x-operation-name":"readVersionNumber","tags":["ContentConfigurationController"],"operationId":"contentConfigReadItemVersionDetails","security":[{"cookieAuth":[]}],"description":"This request returns the content details at a specified version number.","responses":{"200":{"description":"Returns the content details at a specified version number.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["id","title","displayTitle","titleTextProviderName","titleTextProviderKey","summary","versionContent","name","type","updated","created","lastModifier","creator","category","content"],"properties":{"id":{"type":"string","title":"The Id Schema","default":"","pattern":"^(.*)$"},"title":{"type":"object","title":"The Title Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"displayTitle":{"type":"object","title":"The Displaytitle Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"titleTextProviderName":{"type":"string","title":"The Titletextprovidername Schema","default":"","pattern":"^(.*)$"},"titleTextProviderKey":{"type":"string","title":"The Titletextproviderkey Schema","default":"","pattern":"^(.*)$"},"summary":{"type":"object","title":"The Summary Schema","required":["lang"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}},"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"},"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"updated":{"type":"string","title":"The Updated Schema","default":"","pattern":"^(.*)$"},"created":{"type":"string","title":"The Created Schema","default":"","pattern":"^(.*)$"},"lastModifier":{"type":"object","title":"The Lastmodifier Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"creator":{"type":"object","title":"The Creator Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"category":{"type":"array","title":"The Category Schema","items":{"type":"object","title":"The Items Schema","required":["scheme","term","label","lang"],"properties":{"scheme":{"type":"string","title":"The Scheme Schema","default":"","pattern":"^(.*)$"},"term":{"type":"string","title":"The Term Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}}},"content":{"type":"object","title":"The Content Schema","required":["type","value"],"properties":{"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"version_number","in":"path","description":"The version number of the web content item.","schema":{"type":"number"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/webcontent/configuration/{content_id}/versions":{"get":{"x-controller-name":"ContentConfigurationController","x-operation-name":"readVersions","tags":["ContentConfigurationController"],"operationId":"contentConfigReadItemVersions","security":[{"cookieAuth":[]}],"description":"This request returns all versions of a content.","responses":{"200":{"description":"Returns all versions of a content.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["feed"],"properties":{"feed":{"type":"object","title":"The Feed Schema","required":["entry"],"properties":{"entry":{"type":"array","title":"The Entry Schema","items":{"type":"object","title":"The Items Schema","required":["versionContent","link"],"properties":{"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"link":{"type":"object","title":"The Link Schema","properties":{"versionedItem":{"properties":{"href":{"type":"string","title":"The Href Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates/{content_template_id}/apply-changes":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"applyChanges","tags":["ContentTemplateController"],"operationId":"webcontentContentTemplateApplyChanges","security":[{"cookieAuth":[]}],"description":"This request applies a content template to a set of specific content items or to all content items.","responses":{"200":{"description":"Returns the tally of Content/s affected.","content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateId":{"type":"string"},"contentTemplateName":{"type":"string"},"totalCount":{"type":"number"},"convertedCount":{"type":"number"},"alreadyHasDraftsCount":{"type":"number"},"invalidCount":{"type":"number"},"skippedCount":{"type":"number"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template.","example":"e5f37f65-78ad-438c-8b9f-d1922da44f7d","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addNewElements":{"type":"boolean","default":false},"removeElements":{"type":"boolean","default":false},"replaceElements":{"type":"boolean","default":false},"copyHiddenFields":{"type":"boolean","default":false},"saveInvalidItems":{"type":"boolean","default":false},"saveItemsAsDrafts":{"type":"boolean","default":false},"defaultValuesToFields":{"type":"boolean","default":false},"defaultValuesContentId":{"type":"string"},"specificContentIds":{"type":"array","items":{"type":"string"}}}}}},"description":"The fields in the request body are optional parameters. You can remove any fields which are not of your concern.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}/elements/{element_name}":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentUpdateContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request updates a content template element's details.","responses":{"200":{"description":"Returns an updated content template element.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"name":{"type":"string","example":"Example Element"},"type":{"type":"string","enum":["ReferenceComponent","DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LinkComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"ReferenceComponent"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["text/plain","text/html","image/png","image/gif","image/jpeg","application/vnd.ibm.wcm+xml"],"example":"application/vnd.ibm.wcm+xml"},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"value":{"type":"string","example":"

HCL Digital Experience

"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}},"required":["selected","id","value"]}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}},"required":["distinguishedName","uri","name"]}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"element_name","in":"path","description":"The unique name of the web content element","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"MyHTMLComponent","type":"string"},"elementName":{"example":"MyHTMLComponent","type":"string"},"elementType":{"example":"HTMLComponent","type":"string"},"contentType":{"type":"object","properties":{"value":{"example":"This parameter is for HTML Component","type":"string"},"reference":{"type":"object","properties":{"type":{"example":"This parameter is for Reference Component","type":"string"},"uuid":{"example":"This parameter is for Reference Component","type":"string"}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}},"delete":{"x-controller-name":"ContentTemplateController","x-operation-name":"deleteContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentDeleteContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request deletes a content template element.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"elementName":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"element_name","in":"path","description":"The unique name of the web content element","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates/{content_template_id}/elements":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"createContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentCreateContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request creates a new content template element.","responses":{"200":{"description":"Returns a newly created content template element.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"MyHTMLComponent","type":"string","description":"The title of the content template element"},"elementName":{"example":"MyHTMLComponent","type":"string","description":"The unique name of the content template element"},"elementType":{"example":"HTMLComponent","type":"string","description":"The element type of the content template"}}}}},"description":"This is the content template create element request body. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}/prototype":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplatePrototype","tags":["ContentTemplateController"],"operationId":"webcontentUpdateContentTemplatePrototype","security":[{"cookieAuth":[]}],"description":"This request updates the prototype content of a content template.","responses":{"200":{"description":"Returns the prototype content of a content template with its elements. An element with Digital Asset Manager (DAM) asset, includes a damId.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5afd5f47-40b5-4355-92d1-f032cdb3b651"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Prototype or Default Content Display Title"}}},"titleProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example prototype or default content description/summary."}}},"summaryProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"name":{"type":"string","example":"Example Prototype or Default Content Name"},"nameProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.226Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.755Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"sample-keyword"}},"category":{"type":"array","items":{"type":"string","example":"sample-category"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.971Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":"sample alt-text"},"tagName":{"type":"string","example":"sample tagname"},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":"sample description"}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":"examplevalue"}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"accept-language","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"type":"string"},"contentNameProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"},"titleProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"summary":{"type":"string"},"summaryProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}},"category":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"type":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}}}},"createNewParent":{"type":"boolean"},"placement":{"type":"string"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string"},"contentLink":{"type":"string"}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentUpdateContentTemplate","security":[{"cookieAuth":[]}],"description":"This request updates the content template's details.","responses":{"200":{"description":"Returns the updated content template details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"ASampleCotentTemplateName","type":"string"},"title":{"example":"A Sample Content-Template Title","type":"string"},"summary":{"example":"A sample content-template summary.","type":"string"},"locked":{"example":"false","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"patch":{"x-controller-name":"ContentTemplateController","x-operation-name":"patchContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentPatchContentTemplate","security":[{"cookieAuth":[]}],"description":"This request updates the content template's details.","responses":{"200":{"description":"Returns the updated content template details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"ASampleCotentTemplateName","type":"string"},"title":{"example":"A Sample Content-Template Title","type":"string"},"summary":{"example":"A sample content-template summary.","type":"string"},"locked":{"example":"false","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"ContentTemplateController","x-operation-name":"deleteContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentDeleteContentTemplate","security":[{"cookieAuth":[]}],"description":"This request deletes a content template","responses":{"204":{"description":"Returns a success message."},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"createContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentCreateContentTemplate","security":[{"cookieAuth":[]}],"description":"This request creates an authoring template.","responses":{"200":{"description":"Returns the newly created content template.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"MyAuthoringTemplateName","type":"string"},"title":{"example":"My Authoring Template Title","type":"string"},"summary":{"example":"My authoring template summary","type":"string"},"contentAuthoringType":{"example":"accept library|parent","type":"string"},"contentAuthoringKey":{"example":"MyAuthoringTemplateKey","type":"string"}}}}},"description":"Create content template.","x-parameter-index":2}}},"/webcontent/contents/{content_id}/comments":{"post":{"x-controller-name":"ContentController","x-operation-name":"addComment","tags":["ContentController"],"operationId":"webContentContentPostComment","security":[{"cookieAuth":[]}],"description":"This function adds a comment to a content with workflow. Note: Comments are immutable, not a stand-alone entity and part of the content's workflow.","responses":{"200":{"description":"Returns the requested content item's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"summary":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"updated":{"type":"string"},"published":{"type":"string"},"created":{"type":"string"},"author":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string"},"expiryDate":{"type":"string"}}},"content":{"type":"object","properties":{"type":{"type":"string"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"example":"Sample Comment","type":"string"}}}}},"description":"Add comment request body.","x-parameter-index":3}}},"/webcontent/contents/{content_id}/workflow-action":{"post":{"x-controller-name":"WorkflowManagerController","x-operation-name":"workflowManager","tags":["WorkflowManagerController"],"operationId":"webContentWorkflowAction","security":[{"cookieAuth":[]}],"description":"This request shifts the content item to a specified workflow stage.","responses":{"200":{"description":"Returns created content item information. damIds will be included on every elements with DAM assets.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"workflowComment":{"type":"object","properties":{"date":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"comment":{"type":"string","example":"Approve content."},"commenter":{"type":"string","example":"wpsadmin"}}}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"example":"next-stage","type":"string","description":"next-stage, previous-stage, approve, reject, restart, create-draft, process-now and remove-workflow are the various stages"},"comments":{"example":"Moving the content to next stage","type":"string","description":"Comments provided by reviewer or approver during the stage movement (not applicable for process-now and remove-workflow actions)"}}}}},"description":"workflow manager request","x-parameter-index":3}}},"/webcontent/contents/{content_id}":{"put":{"x-controller-name":"ContentController","x-operation-name":"updateContent","tags":["ContentController"],"operationId":"webContentUpdateContent","security":[{"cookieAuth":[]}],"description":"This request updates a content item's details.","responses":{"200":{"description":"Returns the updated content item details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"example":"Body","type":"string"},"title":{"example":"Body","type":"string"},"elementType":{"example":"RichTextComponent","type":"string"},"value":{"example":"HTML Body content","type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"categoryID":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"2020-05-30T00:00:00.000Z","type":"string","description":"This parameter is used update the publish date of the content."},"expiryDate":{"example":"2020-07-28T00:00:00.000Z","type":"string","description":"This parameter is used update the expiry date of the content."},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"library":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the library"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"},"locked":{"example":"true","type":"string","description":"The lock state of content after update"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"patch":{"x-controller-name":"ContentController","x-operation-name":"patchContent","tags":["ContentController"],"operationId":"webContentPatchContent","security":[{"cookieAuth":[]}],"description":"This request updates a content item's details.","responses":{"200":{"description":"Returns the updated content item details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"example":"Body","type":"string"},"title":{"example":"Body","type":"string"},"elementType":{"example":"RichTextComponent","type":"string"},"value":{"example":"HTML Body content","type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"categoryID":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_PUBLISH_DATE_EXAMPLE","type":"string","description":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_PUBLISH_DATE_DESCRIPTION"},"expiryDate":{"example":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_EXPIRY_DATE_EXAMPLE","type":"string","description":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_EXPIRY_DATE_DESCRIPTION"},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"},"locked":{"example":"true","type":"string","description":"The lock state of content after update"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"ContentController","x-operation-name":"deleteContent","tags":["ContentController"],"operationId":"webContentDeleteContent","security":[{"cookieAuth":[]}],"description":"This request deletes a content item.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}]}},"/webcontent/contents":{"post":{"x-controller-name":"ContentController","x-operation-name":"create","tags":["ContentController"],"operationId":"webContentAddContent","security":[{"cookieAuth":[]}],"description":"This request creates a new content.","responses":{"200":{"description":"Returns the content item's details after its successful creation.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"type":"string"},"title":{"type":"string"},"elementType":{"type":"string"},"value":{"type":"string"}},"example":[{"value":"sample text element value","elementName":"Text Element","title":"Text Element","elementType":"TextComponent"},{"value":"

sample rich text element value

\n","elementName":"Rich Text Element","title":"Rich Text Element","elementType":"RichTextComponent"},{"double":"1234567","elementName":"Number Element","title":"Number Element","elementType":"NumericComponent"},{"value":"sample short text element value","elementName":"Short Text Element","title":"Short Text Element","elementType":"ShortTextComponent"},{"date":{"type":"DateTime","value":"Tue, 27 Jul 2021 03:27:20.000Z"},"elementName":"Date and Time Element","title":"Date and Time Element","elementType":"DateComponent"},{"userSelection":[{"name":"wpsadmin","distinguishedName":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},{"name":"wpsadmins","distinguishedName":"cn=wpsadmins,o=defaultWIMFileBasedRealm"}],"elementName":"User Selection Element","title":"User Selection Element","elementType":"UserSelectionComponent"},{"reference":"ec3fb702-a024-4ba5-ae23-a3e7ddabc3cd","elementName":"Component Reference Element","title":"Component Reference Element","elementType":"ReferenceComponent"},{"imageElement":{"fileName":"sample-image-from-local.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=","renditionList":[{"name":"desktop","fileName":"sample-image-from-local-desktop.png","binaryresource":{"fileName":"sample-image-from-local-desktop.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}},{"name":"tablet","fileName":"sample-image-from-local-tablet.png","binaryresource":{"fileName":"sample-image-from-local-tablet.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}},{"name":"smartphone","fileName":"sample-image-from-local-smartphone.png","binaryresource":{"fileName":"sample-image-from-local-smartphone.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}}]},"elementName":"Image Element - Local Storage","title":"Image Element - Local Storage","elementType":"ImageComponent"},{"imageElement":{"fileName":"sample-image-from-dam.png","resourceUri":{"type":"image/png","damId":"3c886c2c-cbf2-44f5-a177-0e41d2554f58","value":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/04575def-91ce-43c6-a093-c2526becee49?binary=true"},"renditionList":[{"name":"desktop","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/b9edeee9-3023-4657-b7a7-8d5946e6efd8?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/b9edeee9-3023-4657-b7a7-8d5946e6efd8?binary=true"},{"name":"tablet","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/0aaa1371-92ec-484e-9915-552c4d03a969?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/0aaa1371-92ec-484e-9915-552c4d03a969?binary=true"},{"name":"smartphone","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/42415ac6-e45c-4e5f-a61f-082e39a6bdef?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/42415ac6-e45c-4e5f-a61f-082e39a6bdef?binary=true"}]},"elementName":"Image Element - DAM","title":"Image Element - DAM","elementType":"ImageComponent"},{"fileElement":{"fileName":"sample-file-from-local.pdf","value":"JVBERi0xLg10cmFpbGVyPDwvUm9vdDw8L1BhZ2VzPDwvS2lkc1s8PC9NZWRpYUJveFswIDAgMyAzXT4+XT4+Pj4+Pg=="},"elementName":"File Element - Local Storage","title":"File Element - Local Storage","elementType":"FileComponent"},{"fileElement":{"fileName":"sample-file-from-DAM.pdf","resourceUri":{"type":"application/pdf","value":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/04575def-91ce-43c6-a093-c2526becee49?binary=true","damId":"3c886c2c-cbf2-44f5-a177-0e41d2554f58"}},"elementName":"File Element - DAM","title":"File Element - DAM","elementType":"FileComponent"},{"linkElement":{"destination":{"type":"external","allowClear":"false","value":"www.sample-url.com"},"display":{"type":"title","value":"www.sample-url.com"},"description":{"useDestination":"false","value":""},"target":"None","additionalAttributes":""},"elementName":"Link Element - External URL","title":"Link Element - External URL","elementType":"LinkComponent"},{"linkElement":{"destination":{"type":"content","allowClear":"false","value":"2ea374a7-3368-4585-b92e-e21ddf0d7436"},"display":{"type":"text","value":"Web Content"},"description":{"useDestination":"false","value":""},"target":"None","additionalAttributes":""},"elementName":"Link Element - Web Content","title":"Link Element - Web Content","elementType":"LinkComponent"},{"optionSelection":{"displaytype":"Automatic","selection":"UserDefined","options":{"mode":"Singleselect","option":[]}},"elementName":"Option Selection Element","title":"Option Selection Element","elementType":"OptionSelectionComponent"}]}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"category":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"2020-05-30T00:00:00.000Z","type":"string","description":"This parameter is used to add the publish date of the content."},"expiryDate":{"example":"2020-07-28T00:00:00.000Z","type":"string","description":"This parameter is used to add the expiry date of the content."},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/favorite-items/{item_id}":{"put":{"x-controller-name":"FavoriteItemsController","x-operation-name":"updateFavoriteState","tags":["FavoriteItemsController"],"operationId":"webContentUpdateFavoriteState","security":[{"cookieAuth":[]}],"description":"This PUT operation adds or removes an item to the user's list of favorites.","responses":{"200":{"description":"Returns the item's details after successfully adding or removing it from the user's favorite items list.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"e3fb0b56-176f-48dd-a764-bd1bb98c0254"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content."}},"type":"object"},"name":{"type":"string","example":"My New Content"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"content":{"required":["type","content"],"properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"required":["elements"],"properties":{"elements":{"required":["element"],"properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Body"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Body"}},"type":"object"},"type":{"type":"string","example":"RichTextComponent"},"data":{"required":["type","value"],"properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"

Welcome to HCL Digital Experience

\n"}},"type":"object"}}}}},"type":"object"}},"type":"object"}},"type":"object"},"links":{"required":["library","parent","versions","preview","contentTemplate"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"parent":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=3ab3b5f9-185d-4e3f-ad09-c074f66beb70"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/e3fb0b56-176f-48dd-a764-bd1bb98c0254/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"},"preview":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/e3fb0b56-176f-48dd-a764-bd1bb98c0254"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}},"type":"object"},"contentTemplate":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/b0ce720c-d6bf-4c29-8307-fbb7cee70e68"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"item_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"isFavorite":{"example":true,"type":"boolean","description":"This parameter is used to update the favorite state."},"itemType":{"example":"ContentTemplate","type":"string","description":"The item type of a favorite item."}}}}},"description":"This request is used to update the favorite item.","x-parameter-index":3}}},"/webcontent/favorite-items":{"get":{"x-controller-name":"FavoriteItemsController","x-operation-name":"getFavoriteItems","tags":["FavoriteItemsController"],"operationId":"getFavoriteItems","security":[{"cookieAuth":[]}],"description":"This request returns a list of favorite web content items.","responses":{"200":{"description":"Returns a list of favorite web content items.","content":{"application/json":{"schema":{"type":"object","properties":{"feed":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"updated":{"type":"string"},"link":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["href","lang","label"]},"previousPage":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["href","lang","label"]}}},"entry":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["rel","lang","label"]}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}},"required":["scheme","term","label","lang"]}}},"required":["id","title","summary","name","type","updated","lastModifier","link","category"]}}},"required":["id","title","updated","entry"]}},"required":["feed"]}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"item_type","in":"query","description":"This parameter is used to query items of a specific item type.","schema":{"type":"array","items":{"type":"string"}}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. The values _ascending or _descending are appended to the query to determine sort order. If _ascending or _descending are not specified, the results as displayed in ascending order.","schema":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","title_ascending","title_descending"],"example":"created_ascending"}},{"name":"offset","in":"query","description":"This parameter is used with the limit parameter to define what set of results to display. For example, if pagesize is set to 5, and the page parameter is set to 2, then only results 6 to 10 will be displayed.","schema":{"type":"number"}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items returned by a query to a set number. It can be used with the page parameter to return specific pages of results.","schema":{"type":"number"}}]}},"/webcontent/libraries/{library_id}":{"put":{"x-controller-name":"LibraryManagerController","x-operation-name":"updateLibrary","tags":["LibraryManagerController"],"operationId":"webContentUpdateLibrary","security":[{"cookieAuth":[]}],"description":"This request updates a library's details.","responses":{"200":{"description":"Returns the updated details of a library.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"example":"Dx library","type":"string"},"summary":{"example":"A modified library","type":"string"},"allowDeletion":{"example":true,"type":"boolean"},"enabled":{"example":true,"type":"boolean"},"language":{"example":"en","type":"string"},"includeDefaultItems":{"example":true,"type":"boolean"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"LibraryManagerController","x-operation-name":"deleteLibrary","tags":["LibraryManagerController"],"operationId":"webContentDeleteLibrary","security":[{"cookieAuth":[]}],"description":"This request deletes a library.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"synchronous","in":"query","description":"The parameter that defines if the operation should be synchronous or asynchronous. (e.g., true)","schema":{"type":"boolean"}}]}},"/webcontent/libraries":{"post":{"x-controller-name":"LibraryManagerController","x-operation-name":"createLibrary","tags":["LibraryManagerController"],"operationId":"webContentAddLibrary","security":[{"cookieAuth":[]}],"description":"This request creates a new library.","responses":{"200":{"description":"Returns the newly created library.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"example":"Dx library","type":"string"},"summary":{"example":"A new library","type":"string"},"allowDeletion":{"example":true,"type":"boolean"},"enabled":{"example":true,"type":"boolean"},"language":{"example":"en","type":"string"},"includeDefaultItems":{"example":true,"type":"boolean"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/site-areas":{"post":{"x-controller-name":"SiteAreaController","x-operation-name":"createSiteArea","tags":["SiteAreaController"],"operationId":"webContentAddSiteaArea","security":[{"cookieAuth":[]}],"description":"This request creates a new site area.","responses":{"200":{"description":"Returns the newly created site area.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"Site Area Title","type":"string"},"parentUUID":{"example":"ID of the parent library or site area","type":"string"},"name":{"example":"Site Area Name","type":"string"},"summary":{"example":"Site Area Summary or Description","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/workflow":{"put":{"x-controller-name":"WorkflowManagerController","x-operation-name":"assignDefaultWorkflow","tags":["WorkflowManagerController"],"deprecated":true,"operationId":"assignDefaultWorkflow","security":[{"cookieAuth":[]}],"description":"This request assigns a workflow to a content template.","responses":{"200":{"description":"Returns the requested content item's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"summary":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"updated":{"type":"string"},"published":{"type":"string"},"created":{"type":"string"},"author":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string"},"expiryDate":{"type":"string"}}},"content":{"type":"object","properties":{"type":{"type":"string"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateId":{"example":"3f721903-7f56-4e82-bcfc-3c3b49d4aa94","type":"string"},"workflowId":{"example":"Moving the content to next stage","type":"string"}}}}},"description":"Assign workflow request.","x-parameter-index":2}}},"/{access_type}/access/collections":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"validateCollection","tags":["AccessControlController"],"operationId":"validateAccessCollections","security":[{"cookieAuth":[]}],"description":"This request validates the access control for a list of resources.","responses":{"200":{"description":"OPENAPI_VALIDATE_POST_REQUEST_TYPE_COLLECTION_POST_RESPONSE","content":{"application/json":{"schema":{"type":"object","properties":{"resourceIdList":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"resourceIdList":{"type":"array","items":{"type":"string"}}}},"example":{"resourceIdList":["",""]}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/{access_type}/access/current-user":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"currentuser","tags":["AccessControlController"],"operationId":"accessCurrentUser","security":[{"cookieAuth":[]}],"description":"This request returns the current user's access level information.","responses":{"200":{"description":"Returns the current user's access level information.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"allowedAccess":{"type":"boolean"},"access":{"type":"object","properties":{"userOwned":{"type":"string"},"private":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/permissions":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getPermissions","tags":["AccessControlController"],"operationId":"accessGetPermissions","security":[{"cookieAuth":[]}],"description":"This request returns list of permissions associated with the same resource item.","responses":{"200":{"description":"Returns a list of permissions associated with the same resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"totalResults":{"type":"number"},"members":{"type":"object","properties":{"Administrator":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"Manager":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"Editor":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"User":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/principals":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getPrincipals","tags":["AccessControlController"],"operationId":"accessGetPrincipals","security":[{"cookieAuth":[]}],"description":"This request returns a list principals of same role and resource.","responses":{"200":{"description":"Returns a list principals of same role and resource.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"role":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/resources/config":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getResourceConfig","tags":["AccessControlController"],"operationId":"accessGetResourceConfig","security":[{"cookieAuth":[]}],"description":"This request returns the configuration of a resource item.","responses":{"200":{"description":"Returns the configuration of a resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"config":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"roleBlock":{"type":"object","properties":{"type":{"type":"string"},"role":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/roles/{role_name}":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"roleInfo","tags":["AccessControlController"],"operationId":"accessGetRoleInfo","security":[{"cookieAuth":[]}],"description":"This request returns a role of a particular resource by its role name.","responses":{"200":{"description":"Returns a role details of a particular resource.","content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"type":"string"},"roleTypeName":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"role_name","in":"path","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/roles":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"roles","tags":["AccessControlController"],"operationId":"accessGetRoles","security":[{"cookieAuth":[]}],"description":"This request returns a list of roles associated with a particular resource item.","responses":{"200":{"description":"Returns a list of roles associated with a particular resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"roles":{"type":"array","items":{"type":"object","properties":{"roleType":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/configuration":{"get":{"x-controller-name":"DxConfigController","x-operation-name":"readDxConfig","tags":["DxConfigController"],"operationId":"dxConfigRead","security":[{"cookieAuth":[]}],"description":"This request returns the DX Core configurations.","responses":{"200":{"description":"Returns the DX Core configurations.","content":{"application/json":{"schema":{"type":"object","properties":{"dam":{"type":"object","properties":{"enabled":{"type":"boolean"},"picker-url-files":{"type":"string"},"picker-url-images":{"type":"string"}}},"wcm":{"type":"object","properties":{"maxUploadSize":{"type":"number","example":16}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/languages/{language_id}":{"get":{"x-controller-name":"LanguagesController","x-operation-name":"language","tags":["LanguagesController"],"operationId":"accessLanguage","security":[{"cookieAuth":[]}],"description":"This request gets a language's details.","responses":{"200":{"description":"Returns all supported languages.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"languages":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"locale":{"type":"string"},"oid":{"type":"string"},"default":{"type":"boolean"},"direction":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string"},"title":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"displayLocale","in":"query","description":"Locale used to filter the language titles. If the specified language is not valid, a fallback language will be selected","schema":{"type":"string"}},{"name":"language_id","in":"path","description":"The ID of the targeted language.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/languages":{"get":{"x-controller-name":"LanguagesController","x-operation-name":"languages","tags":["LanguagesController"],"operationId":"accessLanguages","security":[{"cookieAuth":[]}],"description":"This request returns all supported languages.","responses":{"200":{"description":"Returns all supported languages.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"languages":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"locale":{"type":"string"},"oid":{"type":"string"},"default":{"type":"boolean"},"direction":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string"},"title":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"displayLocale","in":"query","description":"Locale used to filter the language titles. If the specified language is not valid, a fallback language will be selected","schema":{"type":"string"}},{"name":"default","in":"query","description":"true value set to system default language.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/multilingual-config/translation/{content_id}":{"patch":{"x-controller-name":"MLConfigController","x-operation-name":"updateTranslations","tags":["MLConfigController"],"operationId":"updateMLSTranslations","security":[{"cookieAuth":[]}],"description":"This request replaces the details of the multi-lingual service configuration of the specified content item.","responses":{"200":{"description":"Returns the details of the multi-lingual service configuration of the specified content item.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string","example":"fr"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string","example":"d93c0bac-5d62-4680-bb3e-f71337218938"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"es"},"value":{"type":"string","example":"Title"}}},"type":{"type":"string","example":"ShortTextComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"text/plain"},"value":{"type":"string","example":"My text"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","example":"d93c0bac-5d62-4680-bb3e-f71337218938"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"es"},"value":{"type":"string","example":"Title"}}},"type":{"type":"string","example":"ShortTextComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"text/plain"},"value":{"type":"string","example":"My text"}}}}}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}},"get":{"x-controller-name":"MLConfigController","x-operation-name":"getTranslations","tags":["MLConfigController"],"operationId":"accessMLSTranslations","security":[{"cookieAuth":[]}],"description":"This request returns the details of the multi-lingual service configuration of a content item.","responses":{"200":{"description":"Returns the details of the multi-lingual service configuration of the specified content item.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"language","in":"query","description":"Specifies language(s) to use for the translated content. All available translated languages are returned if no language parameter is defined.","schema":{"type":"array","items":{"type":"string"}}},{"name":"allElements","in":"query","schema":{"type":"boolean","default":true},"description":"Boolean value that determines if all elements should be returned."}]}},"/{access_type}/multilingual-config/{library_id}":{"get":{"x-controller-name":"MLConfigController","x-operation-name":"getConfig","tags":["MLConfigController"],"operationId":"accessMLSConfig","security":[{"cookieAuth":[]}],"description":"This request returns the multi-lingual service configuration of a library.","responses":{"200":{"description":"Returns the multi-lingual service configuration of the specified library.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"libraries":{"type":"array","items":{"type":"object","properties":{"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"},"mlsBase":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}}}},"baseLibrary":{"type":"object","properties":{"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"},"mlsBase":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/query-by-text":{"get":{"x-controller-name":"QueryController","x-operation-name":"getDataByText","tags":["QueryController"],"operationId":"webContentQueryByText","security":[{"cookieAuth":[]}],"description":"This request returns a list of resource items which contains the text value being searched.","responses":{"200":{"description":"Returns a list of resource items which contains the text value being searched.","content":{"application/json":{"schema":{"type":"object","properties":{"atom:feed":{"type":"object","properties":{"atom:title":{"type":"string"},"atom:author":{"type":"object","properties":{"atom:name":{"type":"string"}}},"atom:id":{"type":"string"},"atom:category":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"}}},"atom:updated":{"type":"string"},"opensearch:totalResults":{"type":"object","properties":{"#text":{"type":"integer"},"exact":{"type":"string"}}},"opensearch:Query":{"type":"object","properties":{"role":{"type":"string"},"searchTerms":{"type":"string"}}},"opensearch:startIndex":{"type":"integer"},"opensearch:itemsPerPage":{"type":"integer"},"atom:entry":{"type":"object","properties":{"atom:id":{"type":"string"},"atom:title":{"type":"object","properties":{"#text":{"type":"string"},"type":{"type":"string"}}},"atom:category":{"type":"object","properties":{"term":{"type":"string"},"scheme":{"type":"string"},"label":{"type":"string"}}},"opensearch:relevance":{"type":"integer"},"atom:updated":{"type":"string"},"atom:summary":{"type":"object","properties":{"#text":{"type":"string"},"type":{"type":"string"}}},"wplc:field":{"type":"array","items":{"type":"object","properties":{"#text":{"type":"string"},"id":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"query","in":"query","description":"The text that needs to be queried to be performed (e.g., Article ). Note: This is a required parameter. Query performed on all scopes by default","schema":{"type":"string"}},{"name":"scope","in":"query","description":"Scope on where to perform the query.(default: com.ibm.lotus.search.ALL_SOURCES)","schema":{"type":"string"}}]}},"/{access_type}/resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getUserResources","tags":["ResourceController"],"operationId":"getUserResources","security":[{"cookieAuth":[]}],"description":"This request returns all the resources within the scope of a specified role of the current user.","responses":{"200":{"description":"Returns all the resources within the scope of a specified role of the current user.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"roleName","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"},{"name":"parentId","in":"query","description":"The parent ID of the resource.","schema":{"type":"string"},"required":true}]}},"/{access_type}/webcontent/components/{component_id}":{"get":{"x-controller-name":"ComponentController","x-operation-name":"read","tags":["ComponentController"],"operationId":"webContentReadComponent","security":[{"cookieAuth":[]}],"description":"This request returns a component's detail.","responses":{"200":{"description":"Returns a component's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component. (See example below)","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}]}},"/{access_type}/webcontent/components":{"get":{"x-controller-name":"ComponentController","x-operation-name":"components","tags":["ComponentController"],"operationId":"accessComponents","security":[{"cookieAuth":[]}],"description":"This request returns a list of components depending on the search filter and pagination values.","responses":{"200":{"description":"Returns a list of components.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/content-templates/{content_template_id}/prototype":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"readContentTemplatePrototype","tags":["ContentTemplateController"],"operationId":"webcontentReadContentTemplatePrototype","security":[{"cookieAuth":[]}],"description":"This request returns the prototype content of a content template.","responses":{"200":{"description":"Returns the prototype content of a content template with its elements. An element with Digital Asset Manager (DAM) asset, includes a damId.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5afd5f47-40b5-4355-92d1-f032cdb3b651"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Prototype or Default Content Display Title"}}},"titleProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example prototype or default content description/summary."}}},"summaryProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"name":{"type":"string","example":"Example Prototype or Default Content Name"},"nameProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.226Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.755Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"sample-keyword"}},"category":{"type":"array","items":{"type":"string","example":"sample-category"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.971Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":"sample alt-text"},"tagName":{"type":"string","example":"sample tagname"},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":"sample description"}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":"examplevalue"}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/content-templates/{content_template_id}":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"readContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentReadContentTemplate","security":[{"cookieAuth":[]}],"description":"This request returns a content template's details.","responses":{"200":{"description":"Returns a content template's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"8f572e31-3e97-4be0-9838-8a4449b89c36"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Template Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example description/summary."}}},"name":{"type":"string","example":"Example Content Template Name"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.178Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.178Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"elements":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"name":{"type":"string","example":"Example Component Reference"},"type":{"type":"string","example":"ReferenceComponent"},"content":{"type":"object","properties":{"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDeOHPAJR865RC2JMC65BEEJMG62BP0JM47OPCGJM0713D83Q4723EIJHD6M1"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"versions":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/configuration/8f572e31-3e97-4be0-9838-8a4449b89c36/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"true"},"label":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"elements","in":"query","description":"Return the elements of the Content Template","schema":{"type":"boolean"}},{"name":"properties","in":"query","description":"Return the properties of the Content Template","schema":{"type":"boolean"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/content-templates":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"contentTemplates","tags":["ContentTemplateController"],"operationId":"accessContentTemplates","security":[{"cookieAuth":[]}],"description":"This request returns a list of content templates depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of content templates.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/contents/render/{content_id}":{"get":{"x-controller-name":"ContentController","x-operation-name":"render","tags":["ContentController"],"operationId":"webContentRenderContent","security":[{"cookieAuth":[]}],"description":"This request renders the content in HTML.","responses":{"200":{"description":"Returns a message containing the HTML markup of the specified content item.","content":{"text/html":{"schema":{"type":"string","properties":{},"example":"

Welcome to HCL Digital Experience

\n"}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}]}},"/{access_type}/webcontent/contents/{content_id}/current-stage":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStageViaContent","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStageViaContent","security":[{"cookieAuth":[]}],"description":"This request returns the current workflow stage of a content.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"actions":{"type":"object","properties":{"entering":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/contents/{content_id}/workflow":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"readWorkflowViaContent","tags":["WorkflowController"],"operationId":"webContentReadWorkflowViaContent","security":[{"cookieAuth":[]}],"description":"This request returns workflow details of a content.","responses":{"200":{"description":"Returns the workflow's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflow":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"stage":{"type":"object","properties":{"stages":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"draftCreation":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/contents/{content_id}":{"get":{"x-controller-name":"ContentController","x-operation-name":"readContent","tags":["ContentController"],"operationId":"webContentReadContent","security":[{"cookieAuth":[]}],"description":"This request returns a content's details.","responses":{"200":{"description":"Returns created content item information. damIds will be included on every elements with DAM assets.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"workflowComment":{"type":"object","properties":{"date":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"comment":{"type":"string","example":"Approve content."},"commenter":{"type":"string","example":"wpsadmin"}}}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/contents":{"get":{"x-controller-name":"ContentController","x-operation-name":"contents","tags":["ContentController"],"operationId":"accessContents","security":[{"cookieAuth":[]}],"description":"This request returns a list of content items depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of contents.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/libraries/{library_id}/preset-folders":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"readLibraryPresetFolder","tags":["LibraryManagerController"],"operationId":"webContentReadLibraryPresetFolder","security":[{"cookieAuth":[]}],"description":"This request returns the preset folders that were automatically created when a library is created.","responses":{"200":{"description":"Returns the preset folders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"text":{"type":"string"}},"required":["lang","text"]},"updated":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","title","updated","name","type"]}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/libraries/{library_id}":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"readLibrary","tags":["LibraryManagerController"],"operationId":"webContentReadLibrary","security":[{"cookieAuth":[]}],"description":"This request returns a library's details.","responses":{"200":{"description":"Returns the library's details.","content":{"application/json":{"schema":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/libraries":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"libraries","tags":["LibraryManagerController"],"operationId":"accessLibraries","security":[{"cookieAuth":[]}],"description":"This request returns a list of libraries depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of libraries.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/query-by-attribute":{"get":{"x-controller-name":"QueryController","x-operation-name":"getData","tags":["QueryController"],"operationId":"webContentQueryByAttribute","security":[{"cookieAuth":[]}],"description":"Note: This request will be deprecated soon. Please refer to 'GET /{access_type}/webcontent/search' for the same request functionality.","responses":{"200":{"description":"Returns the search results based on its search filter, sorting and pagination values","content":{"application/json":{"schema":{"type":"object","properties":{"feed":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"updated":{"type":"string"},"entry":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"summary":{"type":"object"},"updated":{"type":"string"},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"#text":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"dx:distinguishedName":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/recent-items":{"get":{"x-controller-name":"RecentItemsController","x-operation-name":"getRecentItems","tags":["RecentItemsController"],"operationId":"getRecentItems","security":[{"cookieAuth":[]}],"description":"This request returns a list of recently accessed items.","responses":{"200":{"description":"Returns a list of recently accessed items.","content":{"application/json":{"schema":{"type":"object","properties":{"self":{"type":"string"},"first":{"type":"string"},"next":{"type":"string"},"last":{"type":"string"},"contents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastAccessed":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]},"link":{"type":"object","properties":{"rel":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}}}}},"category":{"type":"object","properties":{"scheme":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}},"required":["id","title","summary","name","type","updated","lastModifier","link","category"]}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"type","in":"query","description":"This parameter is used to query items of a specific item type.","schema":{"type":"array","items":{"type":"string","enum":["Category","Content","ContentTemplate","CustomWorkflowAction","DateComponent","EmailAction","ExpireAction","FileComponent","Folder","HTMLComponent","ImageComponent","JSPComponent","Library","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","LibraryReferenceComponent","LibraryLinkComponent","LibraryTaxonomyComponent","NumericComponent","OptionSelectionComponent","PortalPage","PresentationTemplate","Project","ProjectTemplate","PublishAction","RichTextComponent","ScheduledMoveAction","ShortTextComponent","SiteArea","SiteAreaTemplate","Taxonomy","TextComponent","UserSelectionComponent","VersionAction","Workflow","WorkflowAction","WorkflowStage"]}}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. The values _ascending or _descending are appended to the query to determine sort order. If _ascending or _descending are not specified, the results as displayed in ascending order.","schema":{"type":"string","enum":["accessed_ascending","accessed_descending","author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","title_ascending","title_descending"],"example":"created_ascending"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display. For example, if pagesize is set to 5, and the page parameter is set to 2, then only results 6 to 10 will be displayed.","schema":{"type":"number"}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items returned by a query to a set number. It can be used with the page parameter to return specific pages of results.","schema":{"type":"number"}}]}},"/{access_type}/webcontent/references":{"get":{"x-controller-name":"QueryController","x-operation-name":"getReferences","tags":["QueryController"],"operationId":"webContentGetReferences","security":[{"cookieAuth":[]}],"description":"This request returns a list of content items which references 'itemid'. 'itemid' is any resource ID like content template ID or workflow ID.","responses":{"200":{"description":"Returns the list of content items which references 'itemid'.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"array","items":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}},"path":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"itemId","in":"query","description":"The ID of an item whose references has to be fetched. (e.g., 8d25860b-7a5c-4015-9cd5-bdcc60ce14bb).","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Reference type. Pass wcm or dam to fetch the wcm or dam references correspondingly for an item id","required":true,"schema":{"type":"string","enum":["wcm","dam"],"example":"wcm"}}]}},"/{access_type}/webcontent/search":{"get":{"x-controller-name":"QueryController","x-operation-name":"search","tags":["QueryController"],"operationId":"webContentSearch","security":[{"cookieAuth":[]}],"description":"This request returns a search results based on its search filters, sorting and pagination values.","responses":{"200":{"description":"Returns the search results based on its search filter, sorting and pagination values.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"type","in":"query","description":"This parameter is used to query items of a specific item type. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["Category","Content","ContentTemplate","CustomWorkflowAction","DateComponent","EmailAction","ExpireAction","FileComponent","Folder","HTMLComponent","ImageComponent","JSPComponent","Library","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","LibraryReferenceComponent","LibraryLinkComponent","LibraryTaxonomyComponent","NumericComponent","OptionSelectionComponent","PortalPage","PresentationTemplate","Project","ProjectTemplate","PublishAction","RichTextComponent","ScheduledMoveAction","ShortTextComponent","SiteArea","SiteAreaTemplate","Taxonomy","TextComponent","UserSelectionComponent","VersionAction","Workflow","WorkflowAction","WorkflowStage"]}}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"filteraccess","in":"query","description":"Using the Search API, this parameter is used to filter access control roles. All other parameters, such as parentID or type, remain valid, allowing one to, for example, locate all libraries on which the user has the Editor role. User, Editor, Admin, Manager, and Contributor are all valid roles.","schema":{"type":"string"}},{"name":"depth","in":"query","description":"This parameter is used with the parentid and is used to define whether to search for all descendants of a parent, or just the immediate children of a parent item (e.g., to query only the immediate children of an item, you select CHILDREN, to query all descendants of an item, you select DESCENDANTS).","schema":{"type":"string","enum":["CHILDREN","DESCENDANTS"]}},{"name":"dateFormat","in":"query","description":"This parameter is used to define the date format of query parameters (e.g., mm-dd-yyyy. If a date format is not specified, then the default format yyyy-MM-dd'T'HH:mm:ssz is used).","schema":{"type":"string"}},{"name":"title","in":"query","description":"This parameter is used to query an item with a specific title.","schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","description":"This parameter is used to query an item with a specific name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"query","description":"This parameter is used to query an item with a specific ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"keyword","in":"query","description":"This parameter is used to query items that are profiled with a specific keyword.","schema":{"type":"array","items":{"type":"string"}}},{"name":"creator","in":"query","description":"This parameter is used to query items with a specific creator. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"lastModifier","in":"query","description":"This parameter is used to query items that were last modified by a specific user. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"author","in":"query","description":"This parameter is used to query items with a specific author. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"owner","in":"query","description":"This parameter is used to query items with a specific owner. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"approver","in":"query","description":"This parameter is used to query items with a specific approver. A user ID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"state","in":"query","description":"This parameter is used to query items that are in a specific state. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["DRAFT","EXPIRED","PUBLISHED"]}}},{"name":"projectState","in":"query","description":"This parameter is used to query items that are linked to a project with a specific state. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["ACTIVE","PENDING","PUBLISHED","PUBLISHED_FAILED","PUBLISHING","SYNDICATING"]}}},{"name":"authoringTemplateID","in":"query","description":"This parameter is used to query items with a specific authoring template ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectID","in":"query","description":"This parameter is used to query items that are linked to a specific project (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"workflowID","in":"query","description":"This parameter is used to query items that use a specific workflow (e.g., 8d25860b-7a5c-4015-9cd5-bdcc60ce14bb).","schema":{"type":"array","items":{"type":"string"}}},{"name":"workflowStageID","in":"query","description":"This parameter is used to query items that are currently active within a specific workflow stage (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"categoryID","in":"query","description":"This parameter is used to query items with a specific category ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"string"}},{"name":"createdBefore","in":"query","description":"This parameter is used to query items that are created before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"createdAfter","in":"query","description":"This parameter is used to query items that are created after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"lastModifiedBefore","in":"query","description":"This parameter is used to query items that were last modified before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"lastModifiedAfter","in":"query","description":"This parameter is used to query items that were last modified after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"publishedBefore","in":"query","description":"This parameter is used to query items that are published before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"publishedAfter","in":"query","description":"This parameter is used to query items that are published after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"expiredBefore","in":"query","description":"This parameter is used to query items that were expired before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"expiredAfter","in":"query","description":"This parameter is used to query items that were expired after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}}]}},"/{access_type}/webcontent/site-areas":{"get":{"x-controller-name":"SiteAreaController","x-operation-name":"siteAreas","tags":["SiteAreaController"],"operationId":"accessSiteAreas","security":[{"cookieAuth":[]}],"description":"This request returns a list of site areas depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of all site areas.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflow-actions":{"get":{"x-controller-name":"WorkflowManagerController","x-operation-name":"workflowActions","tags":["WorkflowManagerController"],"operationId":"accessWorkflowActions","security":[{"cookieAuth":[]}],"description":"This request returns all the workflow actions.","responses":{"200":{"description":"Returns a list of all workflow actions.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflow-stages/{workflow_stage_id}":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStage","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStage","security":[{"cookieAuth":[]}],"description":"This request returns a workflow stage details.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"actions":{"type":"object","properties":{"entering":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_stage_id","in":"path","description":"The ID of a workflow stage.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflow-stages":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"workflowStages","tags":["WorkflowStageController"],"operationId":"accessWorkflowStages","security":[{"cookieAuth":[]}],"description":"This request returns all available workflow stages.","responses":{"200":{"description":"Returns a list of all the workflow stages.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflows/{workflow_id}/workflow-stages":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStagesInWorkflow","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStagesInWorkflow","security":[{"cookieAuth":[]}],"description":"This request returns all the workflow stages of a workflow.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"},"total":{"type":"integer"},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}},"position":{"type":"integer"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_id","in":"path","description":"The ID of a workflow.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflows/{workflow_id}":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"readWorkflow","tags":["WorkflowController"],"operationId":"webContentReadWorkflow","security":[{"cookieAuth":[]}],"description":"This request returns the details of a workflow.","responses":{"200":{"description":"Returns the workflow's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflow":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"stage":{"type":"object","properties":{"stages":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"draftCreation":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_id","in":"path","description":"The ID of a workflow.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflows":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"workflows","tags":["WorkflowController"],"operationId":"accessWorkflows","security":[{"cookieAuth":[]}],"description":"This request returns all the available workflows.","responses":{"200":{"description":"Returns a list of a the workflows.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}}},"components":{"securitySchemes":{"cookieAuth":{"description":"LtpaToke2 is going to identifying the user session.","type":"apiKey","in":"cookie","name":"LtpaToken2"}}},"servers":[{"url":"/dx/api/core/v1"}]} \ No newline at end of file +{"openapi":"3.0.0","info":{"title":"Ring API","version":"1.37.0","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to HCL DX 9.5 core platform capabilities.","contact":{}},"paths":{"/access/permissions":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"permissions","tags":["AccessControlController"],"operationId":"addAccessPermissions","security":[{"cookieAuth":[]}],"description":"This request creates a new permission.","responses":{"200":{"description":"Returns a newly created permission.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The ID of the type. (e.g., user, group, virtual). Note: This is a required parameter","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"permissionList":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"example":"uid=userId,o=defaultWIMFileBasedRealm","type":"string"}}}}}},"example":{"permissionList":[{"distinguishedName":"uid=userId,o=defaultWIMFileBasedRealm"}]}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":5}}},"/access/principals/{principal_id}":{"delete":{"x-controller-name":"AccessControlController","x-operation-name":"removePrincipal","tags":["AccessControlController"],"operationId":"accessDeletePrincipal","security":[{"cookieAuth":[]}],"description":"This request deletes a principal.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"principal_id","in":"path","description":"The ID of the principal (user or group). (e.g., 8eAe13RO6G4CL3TGMIPDKBQ6MGHE53P02OTDI3T26M14LRSA6PDE)","schema":{"type":"string"},"required":true}]}},"/access/principals":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"addPrincipal","tags":["AccessControlController"],"operationId":"accessAddPrincipal","security":[{"cookieAuth":[]}],"description":"This request assigns the anonymous user to the specified user role.","responses":{"200":{"description":"Returns the newly created principal.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"role":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}}]}},"/access/resources/config":{"put":{"x-controller-name":"AccessControlController","x-operation-name":"modifyResourceConfig","tags":["AccessControlController"],"operationId":"accessUpdateResourceConfig","security":[{"cookieAuth":[]}],"description":"This request updates the access control configuration.","responses":{"200":{"description":"Returns the configuration of a resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"config":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"roleBlock":{"type":"object","properties":{"type":{"type":"string"},"role":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Specify one of the following values: merge to add role blocks to existing ones. The owner is changed if you specify this value. update to replace existing role blocks and owners. The role blocks and owners are removed if you do not specify them. Update is the default value.","schema":{"type":"string","enum":["update","merge"],"example":"update","default":"update"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ownerId":{"example":"Z9eAe1JRU6N5FDRRANP14GRR47Q5CC38ANPLCI3","type":"string"},"roleBlock":{"type":"array","items":{"type":"object","properties":{"type":{"example":"propagation","type":"string"},"role":{"example":"User","type":"string"}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}}},"/anonymous-resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getAnonymousResources","tags":["ResourceController"],"operationId":"getAnonymousResources","security":[{"cookieAuth":[]}],"description":"This request returns all anonymous resources.","responses":{"200":{"description":"Returns all anonymous resources.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"}]}},"/auth/custom-login":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"custHeadLogin","tags":["AuthenticationController"],"operationId":"authCustomLogin","description":"This request authenticates the user by sending the Cookie header content.","responses":{"200":{"description":"Authenticates the user, sends back new access token in the Cookie, returns login success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}]}},"/auth/login":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"login","tags":["AuthenticationController"],"operationId":"authLogin","description":"This request authenticates the user with username and password.","responses":{"200":{"description":"Authenticates the user, sends new access token in the Cookie, returns login success message.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"example":{"username":"","password":""}}},"description":"Replace the placeholders with your own username and password.","x-parameter-index":1}}},"/auth/logout":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"logout","tags":["AuthenticationController"],"operationId":"authLogout","description":"This request deauthenticates the user.","responses":{"200":{"description":"Deauthenticates the user.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"data":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}]}},"/auth/validate":{"post":{"x-controller-name":"AuthenticationController","x-operation-name":"validateLogin","tags":["AuthenticationController"],"operationId":"authValidateLogin","security":[{"cookieAuth":[]}],"description":"This request validates if the user is still authenticated.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"UId":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}]}},"/resources/{resource_id}":{"post":{"x-controller-name":"ResourceController","x-operation-name":"registerResource","tags":["ResourceController"],"operationId":"registerResource","security":[{"cookieAuth":[]}],"description":"This request sets an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"example":"parentExternalId","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. Note: Value of parent should be \"null\" for top-level resources.","x-parameter-index":3}},"put":{"x-controller-name":"ResourceController","x-operation-name":"updateResource","tags":["ResourceController"],"operationId":"updateResource","security":[{"cookieAuth":[]}],"description":"This request sets an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"example":"parentExternalId","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. Note: Value of parent should be \"null\" for top-level resources.","x-parameter-index":3}},"get":{"x-controller-name":"ResourceController","x-operation-name":"getResourceById","tags":["ResourceController"],"operationId":"getResourceById","security":[{"cookieAuth":[]}],"description":"This request returns a resource's details.","responses":{"200":{"description":"Returns the resource details.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}]},"delete":{"x-controller-name":"ResourceController","x-operation-name":"deregisterResource","tags":["ResourceController"],"operationId":"deregisterResource","security":[{"cookieAuth":[]}],"description":"This request removes an access control to a resource.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resource_id","in":"path","description":"The resource ID.","schema":{"type":"string"},"required":true}]}},"/resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getResources","tags":["ResourceController"],"operationId":"getResource","security":[{"cookieAuth":[]}],"description":"This request returns all the resources.","responses":{"200":{"description":"Returns all the resource.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"filterAccess","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"}]}},"/user-management/attributes/{attribute_name}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getSearchAttributes","tags":["UserManagementController"],"operationId":"getSearchAttributes","security":[{"cookieAuth":[]}],"description":"This request returns the user or user group's attributes.","responses":{"200":{"description":"Returns the user or user group's attributes","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"attribute_name","in":"path","description":"Get all the attributes by users/groups.","examples":{"users":{"value":"users","summary":"Return all attributes defined under the \"users\" profile type"},"usersHomeAddress":{"value":"users/homeAddress","summary":"Return details of the \"homeAddress\" attribute defined under the \"users\" profile type"},"groups":{"value":"groups","summary":"Return all attributes defined under the \"groups\" profile type"},"groupsEntitlementInfo":{"value":"groups/entitlementInfo","summary":"Return details of the \"entitlementInfo\" attribute defined under the \"groups\" profile type"}},"schema":{"type":"string"},"required":true}]}},"/user-management/groups/{group_id}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getGroup","tags":["UserManagementController"],"operationId":"getGroup","security":[{"cookieAuth":[]}],"description":"This request returns a group's details.","responses":{"200":{"description":"Returns group details.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"id":{"type":"string"},"updated":{"type":"string"},"content":{"type":"object","properties":{"profile":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"},"attribute":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"multiValued":{"type":"string"},"attributeValue":{"type":"string"}}}}}}}}}},"example":{"title":"cn=wpsadmins,o=defaultWIMFileBasedRealm","id":"Z8eAe63P66JP6OPCCMM07L9CEJMG6GHP2JM07I9D8MMCC6RDG3O07J1E46SKCG1","updated":"2020-09-14T16:36:33.220Z","content":{"profile":{"type":"group","identifier":"uid=wpsadmin,o=defaultWIMFileBasedRealm","attribute":[{"name":"cn","type":"string","multiValued":"false","attributeValue":"wpsadmin"},{"name":"createTimestamp","type":"dateTime","multiValued":"false","attributeValue":"Sat Sep 05 10:49:09 GMT 2020"}]}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"group_id","in":"path","description":"Group's identifier","schema":{"type":"string"},"required":true},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}}]}},"/user-management/groups":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getGroups","tags":["UserManagementController"],"operationId":"getUsergroup","security":[{"cookieAuth":[]}],"description":"This request returns all user groups.","responses":{"200":{"description":"Returns all of the user groups.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","example":1},"list":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"wpsadmins"},"distinguishedName":{"type":"string","example":"cn=wpsadmins,o=defaultWIMFileBasedRealm"},"id":{"type":"string","example":"Z8eAeIHP0JO06OHP8MM47IPD0JMG6M1E2MM471BC4JMGCK1CC6JPCM9C83O06I1"},"updated":{"type":"string","example":"2020-08-26T20:21:00.166Z"},"profile":{"type":"object","properties":{"identifier":{"type":"string","example":"cn=wpsadmins,o=defaultWIMFileBasedRealm"},"type":{"type":"string","example":"group"},"attributes":{"type":"object","properties":{"identifier":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Z8eAeIHP0JO06OHP8MM47IPD0JMG6M1E2MM471BC4JMGCK1CC6JPCM9C83O06I1"}}},"viewIdentifiers":{"type":"object","properties":{"type":{"type":"string","example":"ViewIdentifierType"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text value"}}},"children":{"type":"object","properties":{"type":{"type":"string","example":"Entity"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text value"}}},"displayName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample display name"}}},"businessCategory":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample business category"}}},"description":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample description"}}},"cn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmins"}}},"partyRoles":{"type":"object","properties":{"type":{"type":"string","example":"PartyRole"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"samplerole"}}},"createTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Fri Aug 11 01:30:30 GMT 2020"}}},"modifyTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Fri Aug 11 01:30:30 GMT 2020"}}}}}}}}}},"index":{"type":"number","example":1},"limit":{"type":"number","example":50},"range":{"type":"string","example":"1-1/1"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","default":1},"description":"The offset attribute of user/group search list. This specifies the offset of the first item in a collection to be returned."},{"name":"limit","in":"query","schema":{"type":"integer","default":4500},"description":"The limit attribute of user/group search list. This constrains the number of items-per-page in a collection returned by a request."},{"name":"filterAttr","in":"query","description":"The filter attribute of user/group search list.","schema":{"type":"string"}},{"name":"filterVal","in":"query","description":"The filter value of user/group search list.","schema":{"type":"string"}},{"name":"memberOf","in":"query","description":"The member of value in user/group search list.","schema":{"type":"string"}},{"name":"expandRefs","in":"query","description":"Boolean value that determines if the complete profiles are embedded in the references.","schema":{"type":"boolean"}},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortByAttributes","in":"query","description":"List of attribute names that specifies the sort order for the results. This is only supported for a paged search.","example":["businessCategory","children","cn","createTimestamp","description","displayName","entitlementInfo","identifier","modifyTimestamp","parent","partyRoles","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"descending","in":"query","description":"Boolean value that determines if the sort direction for attributes will be descending. This is based on the sequence of attributes in sortByAttributes.","schema":{"type":"boolean"}}]}},"/user-management/users/{user_id}":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getUser","tags":["UserManagementController"],"operationId":"getUser","security":[{"cookieAuth":[]}],"description":"This request returns a user's details.","responses":{"200":{"description":"Returns user detail.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"id":{"type":"string"},"updated":{"type":"string"},"content":{"type":"object","properties":{"profile":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"},"attribute":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"multiValued":{"type":"string"},"attributeValue":{"type":"string"}}}}}}}}}},"example":{"title":"uid=wpsadmin,o=defaultWIMFileBasedRealm","id":"Z9eAe1BPAMIH6MHC4JMG6M9EAJMG6H9ECJM8CIHC6MM464BD46SO62JC8JO46G1","updated":"2020-09-14T16:36:33.220Z","content":{"profile":{"type":"user","identifier":"uid=wpsadmin,o=defaultWIMFileBasedRealm","attribute":[{"name":"uid","type":"string","multiValued":"false","attributeValue":"wpsadmin"},{"name":"createTimestamp","type":"dateTime","multiValued":"false","attributeValue":"Sat Sep 05 10:49:09 GMT 2020"}]}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User's identifier","schema":{"type":"string"},"required":true},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}}]}},"/user-management/users":{"get":{"x-controller-name":"UserManagementController","x-operation-name":"getUsers","tags":["UserManagementController"],"operationId":"getUsers","security":[{"cookieAuth":[]}],"description":"This request returns all users.","responses":{"200":{"description":"Returns all users.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","example":5},"list":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"Z9eAe13E8JIPCJ1DCMM07OPOAMMG6KHCGJM47K9CGJMK6H1P63HT6GPC83SC6L1"},"name":{"type":"string","example":"wpsadmin"},"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"updated":{"type":"string","example":"2020-08-11T00:30:42.080Z"},"profile":{"type":"object","properties":{"identifier":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"type":{"type":"string","example":"user"},"attributes":{"type":"object","properties":{"preferredLanguage":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"en"}}},"roomNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"103"}}},"telephoneNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"displayName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"ibm-jobTitle":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample job title"}}},"postalCode":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"27609"}}},"description":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample description text"}}},"title":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample text"}}},"carLicense":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"S123-456-78-901-0"}}},"seeAlso":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample reference text"}}},"createTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Thu Aug 11 01:30:30 GMT 2020"}}},"uid":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"localityName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample locality text"}}},"secretary":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"true"}}},"viewIdentifiers":{"type":"object","properties":{"type":{"type":"string","example":"ViewIdentifierType"},"multiValued":{"type":"string","example":"true"}}},"pager":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"children":{"type":"object","properties":{"type":{"type":"string","example":"Entity"},"multiValued":{"type":"string","example":"true"}}},"street":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Saunders Street"}}},"sn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"businessAddress":{"type":"object","properties":{"type":{"type":"string","example":"AddressType"},"multiValued":{"type":"string","example":"true"}}},"homeAddress":{"type":"object","properties":{"type":{"type":"string","example":"AddressType"},"multiValued":{"type":"string","example":"true"}}},"jpegPhoto":{"type":"object","properties":{"type":{"type":"string","example":"xs:hexBinary"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"FFD8FFE000104A46494600010100004800480000FFE10FFD8FFE000104A46494600010100004800480000FFE10FFD8FFE000104A46494600010100004800480000FFE1000480000FFE10FFD8FFE0"}}},"st":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample st value"}}},"c":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample c value"}}},"manager":{"type":"object","properties":{"type":{"type":"string","example":"xs:anyURI"},"multiValued":{"type":"string","example":"true"}}},"initials":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"JS"}}},"givenName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"mobile":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"groups":{"type":"object","properties":{"type":{"type":"string","example":"Group"},"multiValued":{"type":"string","example":"true"}}},"cn":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"facsimileTelephoneNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"+1-541-754-3010"}}},"l":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample value"}}},"homePostalAddress":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"wpsadmin"}}},"partyRoles":{"type":"object","properties":{"type":{"type":"string","example":"PartyRole"},"multiValued":{"type":"string","example":"true"}}},"stateOrProvinceName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"North Carolina"}}},"postalAddress":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"200 Crossroads Blvd"}}},"departmentNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"S-100"}}},"businessCategory":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"Sample category"}}},"countryName":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"true"},"um:attributeValue":{"type":"string","example":"US"}}},"mail":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"200 Crossroads Blvd"}}},"employeeNumber":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"E-123456"}}},"modifyTimestamp":{"type":"object","properties":{"type":{"type":"string","example":"xs:dateTime"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"Mon Aug 11 00:30:42 GMT 2020"}}},"ibm-primaryEmail":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"username@email.com"}}},"labeledURI":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"/sample/uri"}}},"kerberosId":{"type":"object","properties":{"type":{"type":"string","example":"xs:string"},"multiValued":{"type":"string","example":"false"},"um:attributeValue":{"type":"string","example":"ADAPWS/sample"}}}}}}}}}},"index":{"type":"number","example":1},"limit":{"type":"number","example":50},"range":{"type":"string","example":"1-5/5"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","default":1},"description":"The offset attribute of user/group search list. This specifies the offset of the first item in a collection to be returned."},{"name":"limit","in":"query","schema":{"type":"integer","default":4500},"description":"The limit attribute of user/group search list. This constrains the number of items-per-page in a collection returned by a request."},{"name":"filterAttr","in":"query","description":"The filter attribute of user/group search list.","schema":{"type":"string"}},{"name":"filterVal","in":"query","description":"The filter value of user/group search list.","schema":{"type":"string"}},{"name":"memberOf","in":"query","description":"The member of value in user/group search list.","schema":{"type":"string"}},{"name":"expandRefs","in":"query","description":"Boolean value that determines if the complete profiles are embedded in the references.","schema":{"type":"boolean"}},{"name":"includeAttributes","in":"query","description":"List that specifies which attributes contained within the profiles are returned. By default, if this parameter is omitted, all attributes that hold values are returned.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortByAttributes","in":"query","description":"List of attribute names that specifies the sort order for the results. This is only supported for a paged search.","example":["businessAddress","businessCategory","c","carLicense","children","cn","countryName","createTimestamp","departmentNumber","description","displayName","employeeNumber","entitlementInfo","facsimileTelephoneNumber","givenName","groups","homeAddress","homePostalAddress","ibm-jobTitle","ibm-primaryEmail","initials","jpegPhoto","kerberosId","l","labeledURI","localityName","mail","manager","mobile","modifyTimestamp","pager","parent","partyRoles","postalAddress","postalCode","preferredLanguage","principalName","realm","roomNumber","secretary","seeAlso","sn","st","stateOrProvinceName","street","telephoneNumber","title","uid","viewIdentifiers"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"descending","in":"query","description":"Boolean value that determines if the sort direction for attributes will be descending. This is based on the sequence of attributes in sortByAttributes.","schema":{"type":"boolean"}}]}},"/webcontent/components/{component_id}":{"put":{"x-controller-name":"ComponentController","x-operation-name":"update","tags":["ComponentController"],"operationId":"webContentUpdateComponent","security":[{"cookieAuth":[]}],"description":"This request updates a component.","responses":{"200":{"description":"Returns the updated component details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component.","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"My Updated Title"},"content":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"This is Some HTML Text"}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}},"delete":{"x-controller-name":"ComponentController","x-operation-name":"delete","tags":["ComponentController"],"operationId":"webContentDeleteComponent","security":[{"cookieAuth":[]}],"description":"This request deletes a component.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component. (See example below)","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}]}},"/webcontent/components":{"post":{"x-controller-name":"ComponentController","x-operation-name":"create","tags":["ComponentController"],"operationId":"webContentAddComponent","security":[{"cookieAuth":[]}],"description":"This request creates a new component.","responses":{"200":{"description":"Returns the newly created component.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_type","in":"query","description":"The type of the component.","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"libraryId":{"type":"string","example":"20e55d82-3ff9-40aa-acb3-e0eeddc45ea8"},"name":{"type":"string","example":"MyHTMLComponent"},"title":{"type":"string","example":"My HTML Component"},"content":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"

This is some rich text

\n"}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/configuration/{content_id}/version/{version_number}":{"put":{"x-controller-name":"ContentConfigurationController","x-operation-name":"restoreVersionNumber","tags":["ContentConfigurationController"],"operationId":"contentConfigRestoreItemVersionDetails","security":[{"cookieAuth":[]}],"description":"This request restores a content to a specified version.","responses":{"200":{"description":"Returns the restored content at a specified version number.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["id","title","displayTitle","titleTextProviderName","titleTextProviderKey","summary","versionContent","name","type","updated","created","lastModifier","creator","category","content"],"properties":{"id":{"type":"string","title":"The Id Schema","default":"","pattern":"^(.*)$"},"title":{"type":"object","title":"The Title Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"displayTitle":{"type":"object","title":"The Displaytitle Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"titleTextProviderName":{"type":"string","title":"The Titletextprovidername Schema","default":"","pattern":"^(.*)$"},"titleTextProviderKey":{"type":"string","title":"The Titletextproviderkey Schema","default":"","pattern":"^(.*)$"},"summary":{"type":"object","title":"The Summary Schema","required":["lang"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}},"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"},"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"updated":{"type":"string","title":"The Updated Schema","default":"","pattern":"^(.*)$"},"created":{"type":"string","title":"The Created Schema","default":"","pattern":"^(.*)$"},"lastModifier":{"type":"object","title":"The Lastmodifier Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"creator":{"type":"object","title":"The Creator Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"category":{"type":"array","title":"The Category Schema","items":{"type":"object","title":"The Items Schema","required":["scheme","term","label","lang"],"properties":{"scheme":{"type":"string","title":"The Scheme Schema","default":"","pattern":"^(.*)$"},"term":{"type":"string","title":"The Term Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}}},"content":{"type":"object","title":"The Content Schema","required":["type","value"],"properties":{"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"version_number","in":"path","description":"The version number of the web content item.","schema":{"type":"number"},"required":true},{"name":"publish","in":"query","description":"Boolean value to determine if published or not","schema":{"type":"boolean"}}]},"get":{"x-controller-name":"ContentConfigurationController","x-operation-name":"readVersionNumber","tags":["ContentConfigurationController"],"operationId":"contentConfigReadItemVersionDetails","security":[{"cookieAuth":[]}],"description":"This request returns the content details at a specified version number.","responses":{"200":{"description":"Returns the content details at a specified version number.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["id","title","displayTitle","titleTextProviderName","titleTextProviderKey","summary","versionContent","name","type","updated","created","lastModifier","creator","category","content"],"properties":{"id":{"type":"string","title":"The Id Schema","default":"","pattern":"^(.*)$"},"title":{"type":"object","title":"The Title Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"displayTitle":{"type":"object","title":"The Displaytitle Schema","required":["lang","value"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}},"titleTextProviderName":{"type":"string","title":"The Titletextprovidername Schema","default":"","pattern":"^(.*)$"},"titleTextProviderKey":{"type":"string","title":"The Titletextproviderkey Schema","default":"","pattern":"^(.*)$"},"summary":{"type":"object","title":"The Summary Schema","required":["lang"],"properties":{"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}},"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"},"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"updated":{"type":"string","title":"The Updated Schema","default":"","pattern":"^(.*)$"},"created":{"type":"string","title":"The Created Schema","default":"","pattern":"^(.*)$"},"lastModifier":{"type":"object","title":"The Lastmodifier Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"creator":{"type":"object","title":"The Creator Schema","required":["distinguishedName","name"],"properties":{"distinguishedName":{"type":"string","title":"The Distinguishedname Schema","default":"","pattern":"^(.*)$"},"name":{"type":"string","title":"The Name Schema","default":"","pattern":"^(.*)$"}}},"category":{"type":"array","title":"The Category Schema","items":{"type":"object","title":"The Items Schema","required":["scheme","term","label","lang"],"properties":{"scheme":{"type":"string","title":"The Scheme Schema","default":"","pattern":"^(.*)$"},"term":{"type":"string","title":"The Term Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"}}}},"content":{"type":"object","title":"The Content Schema","required":["type","value"],"properties":{"type":{"type":"string","title":"The Type Schema","default":"","pattern":"^(.*)$"},"value":{"type":"string","title":"The Value Schema","default":"","pattern":"^(.*)$"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"version_number","in":"path","description":"The version number of the web content item.","schema":{"type":"number"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/webcontent/configuration/{content_id}/versions":{"get":{"x-controller-name":"ContentConfigurationController","x-operation-name":"readVersions","tags":["ContentConfigurationController"],"operationId":"contentConfigReadItemVersions","security":[{"cookieAuth":[]}],"description":"This request returns all versions of a content.","responses":{"200":{"description":"Returns all versions of a content.","headers":{"Set-Cookie":{"schema":{"type":"string","example":"LtpaToken2=fd4698c940c6d1da602a70ac34f0b147; Path=/; HttpOnly"}}},"content":{"application/json":{"schema":{"type":"object","title":"The Root Schema","required":["feed"],"properties":{"feed":{"type":"object","title":"The Feed Schema","required":["entry"],"properties":{"entry":{"type":"array","title":"The Entry Schema","items":{"type":"object","title":"The Items Schema","required":["versionContent","link"],"properties":{"versionContent":{"type":"object","title":"The Versioncontent Schema","required":["versionName","versionDate"],"properties":{"versionName":{"type":"string","title":"The Versionname Schema","default":"","pattern":"^(.*)$"},"versionDate":{"type":"string","title":"The Versiondate Schema","default":"","pattern":"^(.*)$"}}},"link":{"type":"object","title":"The Link Schema","properties":{"versionedItem":{"properties":{"href":{"type":"string","title":"The Href Schema","default":"","pattern":"^(.*)$"},"lang":{"type":"string","title":"The Lang Schema","default":"","pattern":"^(.*)$"},"label":{"type":"string","title":"The Label Schema","default":"","pattern":"^(.*)$"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates/{content_template_id}/apply-changes":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"applyChanges","tags":["ContentTemplateController"],"operationId":"webcontentContentTemplateApplyChanges","security":[{"cookieAuth":[]}],"description":"This request applies a content template to a set of specific content items or to all content items.","responses":{"200":{"description":"Returns the tally of Content/s affected.","content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateId":{"type":"string"},"contentTemplateName":{"type":"string"},"totalCount":{"type":"number"},"convertedCount":{"type":"number"},"alreadyHasDraftsCount":{"type":"number"},"invalidCount":{"type":"number"},"skippedCount":{"type":"number"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template.","example":"e5f37f65-78ad-438c-8b9f-d1922da44f7d","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addNewElements":{"type":"boolean","default":false},"removeElements":{"type":"boolean","default":false},"replaceElements":{"type":"boolean","default":false},"copyHiddenFields":{"type":"boolean","default":false},"saveInvalidItems":{"type":"boolean","default":false},"saveItemsAsDrafts":{"type":"boolean","default":false},"defaultValuesToFields":{"type":"boolean","default":false},"defaultValuesContentId":{"type":"string"},"specificContentIds":{"type":"array","items":{"type":"string"}}}}}},"description":"The fields in the request body are optional parameters. You can remove any fields which are not of your concern.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}/elements/{element_name}":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentUpdateContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request updates a content template element's details.","responses":{"200":{"description":"Returns an updated content template element.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"name":{"type":"string","example":"Example Element"},"type":{"type":"string","enum":["ReferenceComponent","DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LinkComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"ReferenceComponent"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["text/plain","text/html","image/png","image/gif","image/jpeg","application/vnd.ibm.wcm+xml"],"example":"application/vnd.ibm.wcm+xml"},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"value":{"type":"string","example":"

HCL Digital Experience

"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}},"required":["selected","id","value"]}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}},"required":["distinguishedName","uri","name"]}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"element_name","in":"path","description":"The unique name of the web content element","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"MyHTMLComponent","type":"string"},"elementName":{"example":"MyHTMLComponent","type":"string"},"elementType":{"example":"HTMLComponent","type":"string"},"contentType":{"type":"object","properties":{"value":{"example":"This parameter is for HTML Component","type":"string"},"reference":{"type":"object","properties":{"type":{"example":"This parameter is for Reference Component","type":"string"},"uuid":{"example":"This parameter is for Reference Component","type":"string"}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":4}},"delete":{"x-controller-name":"ContentTemplateController","x-operation-name":"deleteContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentDeleteContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request deletes a content template element.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"elementName":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"element_name","in":"path","description":"The unique name of the web content element","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates/{content_template_id}/elements":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"createContentTemplateElement","tags":["ContentTemplateController"],"operationId":"webContentCreateContentTemplateElement","security":[{"cookieAuth":[]}],"description":"This request creates a new content template element.","responses":{"200":{"description":"Returns a newly created content template element.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"MyHTMLComponent","type":"string","description":"The title of the content template element"},"elementName":{"example":"MyHTMLComponent","type":"string","description":"The unique name of the content template element"},"elementType":{"example":"HTMLComponent","type":"string","description":"The element type of the content template"}}}}},"description":"This is the content template create element request body. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}/prototype":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplatePrototype","tags":["ContentTemplateController"],"operationId":"webcontentUpdateContentTemplatePrototype","security":[{"cookieAuth":[]}],"description":"This request updates the prototype content of a content template.","responses":{"200":{"description":"Returns the prototype content of a content template with its elements. An element with Digital Asset Manager (DAM) asset, includes a damId.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5afd5f47-40b5-4355-92d1-f032cdb3b651"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Prototype or Default Content Display Title"}}},"titleProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example prototype or default content description/summary."}}},"summaryProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"name":{"type":"string","example":"Example Prototype or Default Content Name"},"nameProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.226Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.755Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"sample-keyword"}},"category":{"type":"array","items":{"type":"string","example":"sample-category"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.971Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":"sample alt-text"},"tagName":{"type":"string","example":"sample tagname"},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":"sample description"}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":"examplevalue"}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"accept-language","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"type":"string"},"contentNameProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"},"titleProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"summary":{"type":"string"},"summaryProperties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}},"category":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"type":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}}}},"createNewParent":{"type":"boolean"},"placement":{"type":"string"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string"},"contentLink":{"type":"string"}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/webcontent/content-templates/{content_template_id}":{"put":{"x-controller-name":"ContentTemplateController","x-operation-name":"updateContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentUpdateContentTemplate","security":[{"cookieAuth":[]}],"description":"This request updates the content template's details.","responses":{"200":{"description":"Returns the updated content template details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"ASampleCotentTemplateName","type":"string"},"title":{"example":"A Sample Content-Template Title","type":"string"},"summary":{"example":"A sample content-template summary.","type":"string"},"locked":{"example":"false","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"patch":{"x-controller-name":"ContentTemplateController","x-operation-name":"patchContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentPatchContentTemplate","security":[{"cookieAuth":[]}],"description":"This request updates the content template's details.","responses":{"200":{"description":"Returns the updated content template details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"ASampleCotentTemplateName","type":"string"},"title":{"example":"A Sample Content-Template Title","type":"string"},"summary":{"example":"A sample content-template summary.","type":"string"},"locked":{"example":"false","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"ContentTemplateController","x-operation-name":"deleteContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentDeleteContentTemplate","security":[{"cookieAuth":[]}],"description":"This request deletes a content template","responses":{"204":{"description":"Returns a success message."},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true}]}},"/webcontent/content-templates":{"post":{"x-controller-name":"ContentTemplateController","x-operation-name":"createContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentCreateContentTemplate","security":[{"cookieAuth":[]}],"description":"This request creates an authoring template.","responses":{"200":{"description":"Returns the newly created content template.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","links","categories"],"properties":{"id":{"type":"string","example":"c71fe93d-fc2b-4c8e-bde0-adbb19ba4251"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Template Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content template."}},"type":"object"},"name":{"type":"string","example":"My new content template"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 19:34:23.281Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"links":{"required":["library","versions"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/c71fe93d-fc2b-4c8e-bde0-adbb19ba4251/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateName":{"example":"MyAuthoringTemplateName","type":"string"},"title":{"example":"My Authoring Template Title","type":"string"},"summary":{"example":"My authoring template summary","type":"string"},"contentAuthoringType":{"example":"accept library|parent","type":"string"},"contentAuthoringKey":{"example":"MyAuthoringTemplateKey","type":"string"}}}}},"description":"Create content template.","x-parameter-index":2}}},"/webcontent/contents/{content_id}/comments":{"post":{"x-controller-name":"ContentController","x-operation-name":"addComment","tags":["ContentController"],"operationId":"webContentContentPostComment","security":[{"cookieAuth":[]}],"description":"This function adds a comment to a content with workflow. Note: Comments are immutable, not a stand-alone entity and part of the content's workflow.","responses":{"200":{"description":"Returns the requested content item's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"summary":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"updated":{"type":"string"},"published":{"type":"string"},"created":{"type":"string"},"author":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string"},"expiryDate":{"type":"string"}}},"content":{"type":"object","properties":{"type":{"type":"string"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"example":"Sample Comment","type":"string"}}}}},"description":"Add comment request body.","x-parameter-index":3}}},"/webcontent/contents/{content_id}/workflow-action":{"post":{"x-controller-name":"WorkflowManagerController","x-operation-name":"workflowManager","tags":["WorkflowManagerController"],"operationId":"webContentWorkflowAction","security":[{"cookieAuth":[]}],"description":"This request shifts the content item to a specified workflow stage.","responses":{"200":{"description":"Returns created content item information. damIds will be included on every elements with DAM assets.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"workflowComment":{"type":"object","properties":{"date":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"comment":{"type":"string","example":"Approve content."},"commenter":{"type":"string","example":"wpsadmin"}}}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"example":"next-stage","type":"string","description":"next-stage, previous-stage, approve, reject, restart, create-draft, process-now and remove-workflow are the various stages"},"comments":{"example":"Moving the content to next stage","type":"string","description":"Comments provided by reviewer or approver during the stage movement (not applicable for process-now and remove-workflow actions)"}}}}},"description":"workflow manager request","x-parameter-index":3}}},"/webcontent/contents/{content_id}":{"put":{"x-controller-name":"ContentController","x-operation-name":"updateContent","tags":["ContentController"],"operationId":"webContentUpdateContent","security":[{"cookieAuth":[]}],"description":"This request updates a content item's details.","responses":{"200":{"description":"Returns the updated content item details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"example":"Body","type":"string"},"title":{"example":"Body","type":"string"},"elementType":{"example":"RichTextComponent","type":"string"},"value":{"example":"HTML Body content","type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"categoryID":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"2020-05-30T00:00:00.000Z","type":"string","description":"This parameter is used update the publish date of the content."},"expiryDate":{"example":"2020-07-28T00:00:00.000Z","type":"string","description":"This parameter is used update the expiry date of the content."},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"library":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the library"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"},"locked":{"example":"true","type":"string","description":"The lock state of content after update"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"patch":{"x-controller-name":"ContentController","x-operation-name":"patchContent","tags":["ContentController"],"operationId":"webContentPatchContent","security":[{"cookieAuth":[]}],"description":"This request updates a content item's details.","responses":{"200":{"description":"Returns the updated content item details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"example":"Body","type":"string"},"title":{"example":"Body","type":"string"},"elementType":{"example":"RichTextComponent","type":"string"},"value":{"example":"HTML Body content","type":"string"}}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"categoryID":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_PUBLISH_DATE_EXAMPLE","type":"string","description":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_PUBLISH_DATE_DESCRIPTION"},"expiryDate":{"example":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_EXPIRY_DATE_EXAMPLE","type":"string","description":"OPENAPI_WEBCONTENT_CONTENTS_CONTENTID_PATCH_REQUEST_WORKFLOW_EXPIRY_DATE_DESCRIPTION"},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"},"locked":{"example":"true","type":"string","description":"The lock state of content after update"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"ContentController","x-operation-name":"deleteContent","tags":["ContentController"],"operationId":"webContentDeleteContent","security":[{"cookieAuth":[]}],"description":"This request deletes a content item.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}]}},"/webcontent/contents":{"post":{"x-controller-name":"ContentController","x-operation-name":"create","tags":["ContentController"],"operationId":"webContentAddContent","security":[{"cookieAuth":[]}],"description":"This request creates a new content.","responses":{"200":{"description":"Returns the content item's details after its successful creation.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentName":{"example":"Sample Example Article","type":"string"},"title":{"example":"Example title","type":"string"},"summary":{"example":"Example summary","type":"string"},"contentElements":{"type":"array","items":{"type":"object","properties":{"elementName":{"type":"string"},"title":{"type":"string"},"elementType":{"type":"string"},"value":{"type":"string"}},"example":[{"value":"sample text element value","elementName":"Text Element","title":"Text Element","elementType":"TextComponent"},{"value":"

sample rich text element value

\n","elementName":"Rich Text Element","title":"Rich Text Element","elementType":"RichTextComponent"},{"double":"1234567","elementName":"Number Element","title":"Number Element","elementType":"NumericComponent"},{"value":"sample short text element value","elementName":"Short Text Element","title":"Short Text Element","elementType":"ShortTextComponent"},{"date":{"type":"DateTime","value":"Tue, 27 Jul 2021 03:27:20.000Z"},"elementName":"Date and Time Element","title":"Date and Time Element","elementType":"DateComponent"},{"userSelection":[{"name":"wpsadmin","distinguishedName":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},{"name":"wpsadmins","distinguishedName":"cn=wpsadmins,o=defaultWIMFileBasedRealm"}],"elementName":"User Selection Element","title":"User Selection Element","elementType":"UserSelectionComponent"},{"reference":"ec3fb702-a024-4ba5-ae23-a3e7ddabc3cd","elementName":"Component Reference Element","title":"Component Reference Element","elementType":"ReferenceComponent"},{"imageElement":{"fileName":"sample-image-from-local.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=","renditionList":[{"name":"desktop","fileName":"sample-image-from-local-desktop.png","binaryresource":{"fileName":"sample-image-from-local-desktop.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}},{"name":"tablet","fileName":"sample-image-from-local-tablet.png","binaryresource":{"fileName":"sample-image-from-local-tablet.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}},{"name":"smartphone","fileName":"sample-image-from-local-smartphone.png","binaryresource":{"fileName":"sample-image-from-local-smartphone.png","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="}}]},"elementName":"Image Element - Local Storage","title":"Image Element - Local Storage","elementType":"ImageComponent"},{"imageElement":{"fileName":"sample-image-from-dam.png","resourceUri":{"type":"image/png","damId":"3c886c2c-cbf2-44f5-a177-0e41d2554f58","value":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/04575def-91ce-43c6-a093-c2526becee49?binary=true"},"renditionList":[{"name":"desktop","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/b9edeee9-3023-4657-b7a7-8d5946e6efd8?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/b9edeee9-3023-4657-b7a7-8d5946e6efd8?binary=true"},{"name":"tablet","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/0aaa1371-92ec-484e-9915-552c4d03a969?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/0aaa1371-92ec-484e-9915-552c4d03a969?binary=true"},{"name":"smartphone","fileName":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/42415ac6-e45c-4e5f-a61f-082e39a6bdef?binary=true","resourceUri":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/42415ac6-e45c-4e5f-a61f-082e39a6bdef?binary=true"}]},"elementName":"Image Element - DAM","title":"Image Element - DAM","elementType":"ImageComponent"},{"fileElement":{"fileName":"sample-file-from-local.pdf","value":"JVBERi0xLg10cmFpbGVyPDwvUm9vdDw8L1BhZ2VzPDwvS2lkc1s8PC9NZWRpYUJveFswIDAgMyAzXT4+XT4+Pj4+Pg=="},"elementName":"File Element - Local Storage","title":"File Element - Local Storage","elementType":"FileComponent"},{"fileElement":{"fileName":"sample-file-from-DAM.pdf","resourceUri":{"type":"application/pdf","value":"http://localhost:3000/dx/api/dam/v1/collections/01bbda2c-6ff9-4d24-ae32-5a80b143efc3/items/3c886c2c-cbf2-44f5-a177-0e41d2554f58/renditions/04575def-91ce-43c6-a093-c2526becee49?binary=true","damId":"3c886c2c-cbf2-44f5-a177-0e41d2554f58"}},"elementName":"File Element - DAM","title":"File Element - DAM","elementType":"FileComponent"},{"linkElement":{"destination":{"type":"external","allowClear":"false","value":"www.sample-url.com"},"display":{"type":"title","value":"www.sample-url.com"},"description":{"useDestination":"false","value":""},"target":"None","additionalAttributes":""},"elementName":"Link Element - External URL","title":"Link Element - External URL","elementType":"LinkComponent"},{"linkElement":{"destination":{"type":"content","allowClear":"false","value":"2ea374a7-3368-4585-b92e-e21ddf0d7436"},"display":{"type":"text","value":"Web Content"},"description":{"useDestination":"false","value":""},"target":"None","additionalAttributes":""},"elementName":"Link Element - Web Content","title":"Link Element - Web Content","elementType":"LinkComponent"},{"optionSelection":{"displaytype":"Automatic","selection":"UserDefined","options":{"mode":"Singleselect","option":[]}},"elementName":"Option Selection Element","title":"Option Selection Element","elementType":"OptionSelectionComponent"}]}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"Sample Keyword"}},"category":{"type":"array","items":{"type":"string","example":"ID of the Category"}}}},"workflow":{"example":"a6fb44c0-7185-404b-bf17-a64279f09b0f","type":"string","description":"The ID of the workflow"},"publishDate":{"example":"2020-05-30T00:00:00.000Z","type":"string","description":"This parameter is used to add the publish date of the content."},"expiryDate":{"example":"2020-07-28T00:00:00.000Z","type":"string","description":"This parameter is used to add the expiry date of the content."},"parent":{"example":"0b349dc7-a68e-4f21-861e-9017a8c74fa2","type":"string","description":"The ID of the site area"},"contentTemplate":{"example":"33a2711b-3153-45db-b817-47fc0a4aeff7","type":"string","description":"The ID of the Authoring template"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/favorite-items/{item_id}":{"put":{"x-controller-name":"FavoriteItemsController","x-operation-name":"updateFavoriteState","tags":["FavoriteItemsController"],"operationId":"webContentUpdateFavoriteState","security":[{"cookieAuth":[]}],"description":"This PUT operation adds or removes an item to the user's list of favorites.","responses":{"200":{"description":"Returns the item's details after successfully adding or removing it from the user's favorite items list.","content":{"application/json":{"schema":{"type":"object","required":["id","title","summary","name","type","updated","created","lastModifier","creator","profile","content","links","categories"],"properties":{"id":{"type":"string","example":"e3fb0b56-176f-48dd-a764-bd1bb98c0254"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"My HCL Digital Experience Content Title"}},"type":"object"},"summary":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"A sample summary text for my new content."}},"type":"object"},"name":{"type":"string","example":"My New Content"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"created":{"type":"string","example":"Mon, 20 Jan 2020 20:44:50.692Z"},"lastModifier":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"creator":{"required":["distinguishedName","uri","name"],"properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAe53DAMPKCOHOIJM06H1CEJMG66JC8JM4CK9O8MMK61RCGJHHC3BEG3IT6I1"},"name":{"type":"string","example":"wpsadmin"}},"type":"object"},"profile":{"properties":{},"type":"object"},"content":{"required":["type","content"],"properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"required":["elements"],"properties":{"elements":{"required":["element"],"properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Body"},"title":{"required":["lang","value"],"properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Body"}},"type":"object"},"type":{"type":"string","example":"RichTextComponent"},"data":{"required":["type","value"],"properties":{"type":{"type":"string","example":"text/html"},"value":{"type":"string","example":"

Welcome to HCL Digital Experience

\n"}},"type":"object"}}}}},"type":"object"}},"type":"object"}},"type":"object"},"links":{"required":["library","parent","versions","preview","contentTemplate"],"properties":{"library":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/6eca94b5-e168-423a-b843-5d55d27e1e35"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}},"type":"object"},"parent":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=3ab3b5f9-185d-4e3f-ad09-c074f66beb70"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}},"type":"object"},"versions":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/webcontent/configuration/e3fb0b56-176f-48dd-a764-bd1bb98c0254/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}},"type":"object"},"preview":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/e3fb0b56-176f-48dd-a764-bd1bb98c0254"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}},"type":"object"},"contentTemplate":{"required":["href","lang","label"],"properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/b0ce720c-d6bf-4c29-8307-fbb7cee70e68"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}},"type":"object"}},"type":"object"},"categories":{"required":["workflowState","favorite"],"properties":{"workflowState":{"required":["term","label","lang"],"properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}},"type":"object"},"favorite":{"required":["term","lang"],"properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}},"type":"object"}},"type":"object"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"item_id","in":"path","description":"The ID of the web content item. (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"isFavorite":{"example":true,"type":"boolean","description":"This parameter is used to update the favorite state."},"itemType":{"example":"ContentTemplate","type":"string","description":"The item type of a favorite item."}}}}},"description":"This request is used to update the favorite item.","x-parameter-index":3}}},"/webcontent/favorite-items":{"get":{"x-controller-name":"FavoriteItemsController","x-operation-name":"getFavoriteItems","tags":["FavoriteItemsController"],"operationId":"getFavoriteItems","security":[{"cookieAuth":[]}],"description":"This request returns a list of favorite web content items.","responses":{"200":{"description":"Returns a list of favorite web content items.","content":{"application/json":{"schema":{"type":"object","properties":{"feed":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"updated":{"type":"string"},"link":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["href","lang","label"]},"previousPage":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["href","lang","label"]}}},"entry":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}},"required":["rel","lang","label"]}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}},"required":["scheme","term","label","lang"]}}},"required":["id","title","summary","name","type","updated","lastModifier","link","category"]}}},"required":["id","title","updated","entry"]}},"required":["feed"]}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"item_type","in":"query","description":"This parameter is used to query items of a specific item type.","schema":{"type":"array","items":{"type":"string"}}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. The values _ascending or _descending are appended to the query to determine sort order. If _ascending or _descending are not specified, the results as displayed in ascending order.","schema":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","title_ascending","title_descending"],"example":"created_ascending"}},{"name":"offset","in":"query","description":"This parameter is used with the limit parameter to define what set of results to display. For example, if pagesize is set to 5, and the page parameter is set to 2, then only results 6 to 10 will be displayed.","schema":{"type":"number"}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items returned by a query to a set number. It can be used with the page parameter to return specific pages of results.","schema":{"type":"number"}}]}},"/webcontent/libraries/{library_id}":{"put":{"x-controller-name":"LibraryManagerController","x-operation-name":"updateLibrary","tags":["LibraryManagerController"],"operationId":"webContentUpdateLibrary","security":[{"cookieAuth":[]}],"description":"This request updates a library's details.","responses":{"200":{"description":"Returns the updated details of a library.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"example":"Dx library","type":"string"},"summary":{"example":"A modified library","type":"string"},"allowDeletion":{"example":true,"type":"boolean"},"enabled":{"example":true,"type":"boolean"},"language":{"example":"en","type":"string"},"includeDefaultItems":{"example":true,"type":"boolean"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}},"delete":{"x-controller-name":"LibraryManagerController","x-operation-name":"deleteLibrary","tags":["LibraryManagerController"],"operationId":"webContentDeleteLibrary","security":[{"cookieAuth":[]}],"description":"This request deletes a library.","responses":{"200":{"description":"Returns a success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"synchronous","in":"query","description":"The parameter that defines if the operation should be synchronous or asynchronous. (e.g., true)","schema":{"type":"boolean"}}]}},"/webcontent/libraries":{"post":{"x-controller-name":"LibraryManagerController","x-operation-name":"createLibrary","tags":["LibraryManagerController"],"operationId":"webContentAddLibrary","security":[{"cookieAuth":[]}],"description":"This request creates a new library.","responses":{"200":{"description":"Returns the newly created library.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"example":"Dx library","type":"string"},"summary":{"example":"A new library","type":"string"},"allowDeletion":{"example":true,"type":"boolean"},"enabled":{"example":true,"type":"boolean"},"language":{"example":"en","type":"string"},"includeDefaultItems":{"example":true,"type":"boolean"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/site-areas":{"post":{"x-controller-name":"SiteAreaController","x-operation-name":"createSiteArea","tags":["SiteAreaController"],"operationId":"webContentAddSiteaArea","security":[{"cookieAuth":[]}],"description":"This request creates a new site area.","responses":{"200":{"description":"Returns the newly created site area.","content":{"application/json":{"schema":{"type":"object","properties":{"entry":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"example":"Site Area Title","type":"string"},"parentUUID":{"example":"ID of the parent library or site area","type":"string"},"name":{"example":"Site Area Name","type":"string"},"summary":{"example":"Site Area Summary or Description","type":"string"}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":2}}},"/webcontent/workflow":{"put":{"x-controller-name":"WorkflowManagerController","x-operation-name":"assignDefaultWorkflow","tags":["WorkflowManagerController"],"deprecated":true,"operationId":"assignDefaultWorkflow","security":[{"cookieAuth":[]}],"description":"This request assigns a workflow to a content template.","responses":{"200":{"description":"Returns the requested content item's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"summary":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"updated":{"type":"string"},"published":{"type":"string"},"created":{"type":"string"},"author":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string"},"expiryDate":{"type":"string"}}},"content":{"type":"object","properties":{"type":{"type":"string"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"},"lang":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"409":{"description":"Returns status 409 - Conflict. Check for request data that violates unique constraints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contentTemplateId":{"example":"3f721903-7f56-4e82-bcfc-3c3b49d4aa94","type":"string"},"workflowId":{"example":"Moving the content to next stage","type":"string"}}}}},"description":"Assign workflow request.","x-parameter-index":2}}},"/{access_type}/access/collections":{"post":{"x-controller-name":"AccessControlController","x-operation-name":"validateCollection","tags":["AccessControlController"],"operationId":"validateAccessCollections","security":[{"cookieAuth":[]}],"description":"This request validates the access control for a list of resources.","responses":{"200":{"description":"OPENAPI_VALIDATE_POST_REQUEST_TYPE_COLLECTION_POST_RESPONSE","content":{"application/json":{"schema":{"type":"object","properties":{"resourceIdList":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"resourceIdList":{"type":"array","items":{"type":"string"}}}},"example":{"resourceIdList":["",""]}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}}},"/{access_type}/access/current-user":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"currentuser","tags":["AccessControlController"],"operationId":"accessCurrentUser","security":[{"cookieAuth":[]}],"description":"This request returns the current user's access level information.","responses":{"200":{"description":"Returns the current user's access level information.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"allowedAccess":{"type":"boolean"},"access":{"type":"object","properties":{"userOwned":{"type":"string"},"private":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/permissions":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getPermissions","tags":["AccessControlController"],"operationId":"accessGetPermissions","security":[{"cookieAuth":[]}],"description":"This request returns list of permissions associated with the same resource item.","responses":{"200":{"description":"Returns a list of permissions associated with the same resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"totalResults":{"type":"number"},"members":{"type":"object","properties":{"Administrator":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"Manager":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"Editor":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}},"User":{"type":"object","properties":{"totalResults":{"type":"number"},"permissionList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uniqueName":{"type":"string"},"accessType":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/principals":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getPrincipals","tags":["AccessControlController"],"operationId":"accessGetPrincipals","security":[{"cookieAuth":[]}],"description":"This request returns a list principals of same role and resource.","responses":{"200":{"description":"Returns a list principals of same role and resource.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"role":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"roleName","in":"query","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/resources/config":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"getResourceConfig","tags":["AccessControlController"],"operationId":"accessGetResourceConfig","security":[{"cookieAuth":[]}],"description":"This request returns the configuration of a resource item.","responses":{"200":{"description":"Returns the configuration of a resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"config":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"roleBlock":{"type":"object","properties":{"type":{"type":"string"},"role":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/roles/{role_name}":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"roleInfo","tags":["AccessControlController"],"operationId":"accessGetRoleInfo","security":[{"cookieAuth":[]}],"description":"This request returns a role of a particular resource by its role name.","responses":{"200":{"description":"Returns a role details of a particular resource.","content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"type":"string"},"roleTypeName":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"role_name","in":"path","description":"The unique name of the role (e.g. User).","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/access/roles":{"get":{"x-controller-name":"AccessControlController","x-operation-name":"roles","tags":["AccessControlController"],"operationId":"accessGetRoles","security":[{"cookieAuth":[]}],"description":"This request returns a list of roles associated with a particular resource item.","responses":{"200":{"description":"Returns a list of roles associated with a particular resource item.","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string"},"startIndex":{"type":"number"},"itemsPerPage":{"type":"number"},"totalResults":{"type":"number"},"roles":{"type":"array","items":{"type":"object","properties":{"roleType":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"resourceId","in":"query","description":"The ID of the resource.","required":true,"schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/configuration":{"get":{"x-controller-name":"DxConfigController","x-operation-name":"readDxConfig","tags":["DxConfigController"],"operationId":"dxConfigRead","security":[{"cookieAuth":[]}],"description":"This request returns the DX Core configurations.","responses":{"200":{"description":"Returns the DX Core configurations.","content":{"application/json":{"schema":{"type":"object","properties":{"dam":{"type":"object","properties":{"enabled":{"type":"boolean"},"picker-url-files":{"type":"string"},"picker-url-images":{"type":"string"}}},"wcm":{"type":"object","properties":{"maxUploadSize":{"type":"number","example":16}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/languages/{language_id}":{"get":{"x-controller-name":"LanguagesController","x-operation-name":"language","tags":["LanguagesController"],"operationId":"accessLanguage","security":[{"cookieAuth":[]}],"description":"This request gets a language's details.","responses":{"200":{"description":"Returns all supported languages.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"languages":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"locale":{"type":"string"},"oid":{"type":"string"},"default":{"type":"boolean"},"direction":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string"},"title":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"displayLocale","in":"query","description":"Locale used to filter the language titles. If the specified language is not valid, a fallback language will be selected","schema":{"type":"string"}},{"name":"language_id","in":"path","description":"The ID of the targeted language.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/languages":{"get":{"x-controller-name":"LanguagesController","x-operation-name":"languages","tags":["LanguagesController"],"operationId":"accessLanguages","security":[{"cookieAuth":[]}],"description":"This request returns all supported languages.","responses":{"200":{"description":"Returns all supported languages.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"languages":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"locale":{"type":"string"},"oid":{"type":"string"},"default":{"type":"boolean"},"direction":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string"},"title":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"displayLocale","in":"query","description":"Locale used to filter the language titles. If the specified language is not valid, a fallback language will be selected","schema":{"type":"string"}},{"name":"default","in":"query","description":"true value set to system default language.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/multilingual-config/translation/{content_id}":{"patch":{"x-controller-name":"MLConfigController","x-operation-name":"updateTranslations","tags":["MLConfigController"],"operationId":"updateMLSTranslations","security":[{"cookieAuth":[]}],"description":"This request replaces the details of the multi-lingual service configuration of the specified content item.","responses":{"200":{"description":"Returns the details of the multi-lingual service configuration of the specified content item.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string","example":"fr"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string","example":"d93c0bac-5d62-4680-bb3e-f71337218938"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"es"},"value":{"type":"string","example":"Title"}}},"type":{"type":"string","example":"ShortTextComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"text/plain"},"value":{"type":"string","example":"My text"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","example":"d93c0bac-5d62-4680-bb3e-f71337218938"},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"es"},"value":{"type":"string","example":"Title"}}},"type":{"type":"string","example":"ShortTextComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"text/plain"},"value":{"type":"string","example":"My text"}}}}}}}}}}}}},"description":"In the key:value fields of the JSON below, you may need to replace the values with your own to complete this request. For an element with a Digital Asset Manager (DAM) asset, you need to include its damId.","x-parameter-index":3}},"get":{"x-controller-name":"MLConfigController","x-operation-name":"getTranslations","tags":["MLConfigController"],"operationId":"accessMLSTranslations","security":[{"cookieAuth":[]}],"description":"This request returns the details of the multi-lingual service configuration of a content item.","responses":{"200":{"description":"Returns the details of the multi-lingual service configuration of the specified content item.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"object","properties":{"sourceLanguage":{"type":"string","example":"en"},"translatedLanguages":{"type":"array","items":{"type":"string"}},"sourceItem":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}},"translatedItems":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"type":"string"}},"elements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"},"data":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"language","in":"query","description":"Specifies language(s) to use for the translated content. All available translated languages are returned if no language parameter is defined.","schema":{"type":"array","items":{"type":"string"}}},{"name":"allElements","in":"query","schema":{"type":"boolean","default":true},"description":"Boolean value that determines if all elements should be returned."}]}},"/{access_type}/multilingual-config/{library_id}":{"get":{"x-controller-name":"MLConfigController","x-operation-name":"getConfig","tags":["MLConfigController"],"operationId":"accessMLSConfig","security":[{"cookieAuth":[]}],"description":"This request returns the multi-lingual service configuration of a library.","responses":{"200":{"description":"Returns the multi-lingual service configuration of the specified library.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"libraries":{"type":"array","items":{"type":"object","properties":{"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"},"mlsBase":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}}}},"baseLibrary":{"type":"object","properties":{"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"},"mlsBase":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"405":{"description":"Returns status 405 - Method Not Allowed error is not commonly used.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/query-by-text":{"get":{"x-controller-name":"QueryController","x-operation-name":"getDataByText","tags":["QueryController"],"operationId":"webContentQueryByText","security":[{"cookieAuth":[]}],"description":"This request returns a list of resource items which contains the text value being searched.","responses":{"200":{"description":"Returns a list of resource items which contains the text value being searched.","content":{"application/json":{"schema":{"type":"object","properties":{"atom:feed":{"type":"object","properties":{"atom:title":{"type":"string"},"atom:author":{"type":"object","properties":{"atom:name":{"type":"string"}}},"atom:id":{"type":"string"},"atom:category":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"}}},"atom:updated":{"type":"string"},"opensearch:totalResults":{"type":"object","properties":{"#text":{"type":"integer"},"exact":{"type":"string"}}},"opensearch:Query":{"type":"object","properties":{"role":{"type":"string"},"searchTerms":{"type":"string"}}},"opensearch:startIndex":{"type":"integer"},"opensearch:itemsPerPage":{"type":"integer"},"atom:entry":{"type":"object","properties":{"atom:id":{"type":"string"},"atom:title":{"type":"object","properties":{"#text":{"type":"string"},"type":{"type":"string"}}},"atom:category":{"type":"object","properties":{"term":{"type":"string"},"scheme":{"type":"string"},"label":{"type":"string"}}},"opensearch:relevance":{"type":"integer"},"atom:updated":{"type":"string"},"atom:summary":{"type":"object","properties":{"#text":{"type":"string"},"type":{"type":"string"}}},"wplc:field":{"type":"array","items":{"type":"object","properties":{"#text":{"type":"string"},"id":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"query","in":"query","description":"The text that needs to be queried to be performed (e.g., Article ). Note: This is a required parameter. Query performed on all scopes by default","schema":{"type":"string"}},{"name":"scope","in":"query","description":"Scope on where to perform the query.(default: com.ibm.lotus.search.ALL_SOURCES)","schema":{"type":"string"}}]}},"/{access_type}/resources":{"get":{"x-controller-name":"ResourceController","x-operation-name":"getUserResources","tags":["ResourceController"],"operationId":"getUserResources","security":[{"cookieAuth":[]}],"description":"This request returns all the resources within the scope of a specified role of the current user.","responses":{"200":{"description":"Returns all the resources within the scope of a specified role of the current user.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"},"resources":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"internalID":{"type":"string"},"parent":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"roleName","in":"query","schema":{"type":"string","default":"User"},"description":"Filter access parameter to check the resources for specific roles. Examples: Manager, Editor, User"},{"name":"parentId","in":"query","description":"The parent ID of the resource.","schema":{"type":"string"},"required":true}]}},"/{access_type}/webcontent/components/{component_id}":{"get":{"x-controller-name":"ComponentController","x-operation-name":"read","tags":["ComponentController"],"operationId":"webContentReadComponent","security":[{"cookieAuth":[]}],"description":"This request returns a component's detail.","responses":{"200":{"description":"Returns a component's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string"}}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"component_id","in":"path","description":"The ID of the component. (See example below)","example":"396b84c8-90ef-489a-b054-1f788eb6a8ff","schema":{"type":"string"},"required":true},{"name":"component_type","in":"query","description":"The type of the component. (See example below)","schema":{"type":"string","enum":["DateComponent","FileComponent","HTMLComponent","ImageComponent","JSPComponent","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","NumericComponent","OptionSelectionComponent","RichTextComponent","ScheduledMoveAction","ShortTextComponent","TextComponent","UserSelectionComponent"],"example":"LibraryHTMLComponent"}}]}},"/{access_type}/webcontent/components":{"get":{"x-controller-name":"ComponentController","x-operation-name":"components","tags":["ComponentController"],"operationId":"accessComponents","security":[{"cookieAuth":[]}],"description":"This request returns a list of components depending on the search filter and pagination values.","responses":{"200":{"description":"Returns a list of components.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/content-templates/{content_template_id}/prototype":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"readContentTemplatePrototype","tags":["ContentTemplateController"],"operationId":"webcontentReadContentTemplatePrototype","security":[{"cookieAuth":[]}],"description":"This request returns the prototype content of a content template.","responses":{"200":{"description":"Returns the prototype content of a content template with its elements. An element with Digital Asset Manager (DAM) asset, includes a damId.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5afd5f47-40b5-4355-92d1-f032cdb3b651"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Prototype or Default Content Display Title"}}},"titleProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example prototype or default content description/summary."}}},"summaryProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"name":{"type":"string","example":"Example Prototype or Default Content Name"},"nameProperties":{"type":"object","properties":{"type":{"type":"string","example":"text/html"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"WIDTH"},"value":{"type":"string","example":"50"}}}}}},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.226Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.755Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"sample-keyword"}},"category":{"type":"array","items":{"type":"string","example":"sample-category"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.971Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":"sample alt-text"},"tagName":{"type":"string","example":"sample tagname"},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":"sample description"}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":"examplevalue"}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/content-templates/{content_template_id}":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"readContentTemplate","tags":["ContentTemplateController"],"operationId":"webContentReadContentTemplate","security":[{"cookieAuth":[]}],"description":"This request returns a content template's details.","responses":{"200":{"description":"Returns a content template's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"8f572e31-3e97-4be0-9838-8a4449b89c36"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Template Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example description/summary."}}},"name":{"type":"string","example":"Example Content Template Name"},"type":{"type":"string","example":"ContentTemplate"},"updated":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.178Z"},"created":{"type":"string","example":"Thu, 11 Aug 2020 00:00:00.178Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"elements":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"name":{"type":"string","example":"Example Component Reference"},"type":{"type":"string","example":"ReferenceComponent"},"content":{"type":"object","properties":{"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"beda761b-b52b-4f7e-ac53-ec1a2ee92ba1"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/beda761b-b52b-4f7e-ac53-ec1a2ee92ba1/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"206d0c34-24b0-4117-b651-494c5a30b40a"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/206d0c34-24b0-4117-b651-494c5a30b40a/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"sample/path"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"81,186"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}}}}}}}}},"properties":{"type":"object","properties":{"workflow-control":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ENABLE_WORKFLOW"},"enabled":{"type":"boolean","example":true}}}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","example":"default-presentation"},"href":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/PresentationTemplate/856690bf-9808-4335-bc5d-b5891138d979"},"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Default Presentation"}}}},"createNewParent":{"type":"boolean","example":false},"placement":{"type":"string","example":"LAST_CHILD"},"location-options":{"type":"object","properties":{"allowedLocation":{"type":"string","example":"ALL_AVAILABLE"},"contentLink":{"type":"string","example":"NONE"}}}}},"links":{"type":"object","properties":{"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDeOHPAJR865RC2JMC65BEEJMG62BP0JM47OPCGJM0713D83Q4723EIJHD6M1"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"versions":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/configuration/8f572e31-3e97-4be0-9838-8a4449b89c36/versions"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Versions"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"PUBLISHED"},"label":{"type":"string","example":"Published"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"false"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"true"},"label":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_template_id","in":"path","description":"The ID of the content template","schema":{"type":"string"},"required":true},{"name":"elements","in":"query","description":"Return the elements of the Content Template","schema":{"type":"boolean"}},{"name":"properties","in":"query","description":"Return the properties of the Content Template","schema":{"type":"boolean"}},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/content-templates":{"get":{"x-controller-name":"ContentTemplateController","x-operation-name":"contentTemplates","tags":["ContentTemplateController"],"operationId":"accessContentTemplates","security":[{"cookieAuth":[]}],"description":"This request returns a list of content templates depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of content templates.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/contents/render/{content_id}":{"get":{"x-controller-name":"ContentController","x-operation-name":"render","tags":["ContentController"],"operationId":"webContentRenderContent","security":[{"cookieAuth":[]}],"description":"This request renders the content in HTML.","responses":{"200":{"description":"Returns a message containing the HTML markup of the specified content item.","content":{"text/html":{"schema":{"type":"string","properties":{},"example":"

Welcome to HCL Digital Experience

\n"}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}}]}},"/{access_type}/webcontent/contents/{content_id}/current-stage":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStageViaContent","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStageViaContent","security":[{"cookieAuth":[]}],"description":"This request returns the current workflow stage of a content.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"actions":{"type":"object","properties":{"entering":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/contents/{content_id}/workflow":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"readWorkflowViaContent","tags":["WorkflowController"],"operationId":"webContentReadWorkflowViaContent","security":[{"cookieAuth":[]}],"description":"This request returns workflow details of a content.","responses":{"200":{"description":"Returns the workflow's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflow":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"stage":{"type":"object","properties":{"stages":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"draftCreation":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/contents/{content_id}":{"get":{"x-controller-name":"ContentController","x-operation-name":"readContent","tags":["ContentController"],"operationId":"webContentReadContent","security":[{"cookieAuth":[]}],"description":"This request returns a content's details.","responses":{"200":{"description":"Returns created content item information. damIds will be included on every elements with DAM assets.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ad0490ea-27cb-4392-801b-5b559170e69e"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Content Display Title"}}},"summary":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example content description/summary."}}},"name":{"type":"string","example":"Example Content Name"},"type":{"type":"string","example":"Content"},"updated":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"created":{"type":"string","example":"Fri, 11 Aug 2020 00:00:00.789Z"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"owner":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"creator":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}},"profile":{"type":"object","properties":{"keyword":{"type":"array","items":{"type":"string","example":"samplekeyword"}},"category":{"type":"array","items":{"type":"string","example":"samplecategory"}}}},"workflow":{"type":"object","properties":{"publishDate":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"},"expiryDate":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"generalDateOne":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"generalDateTwo":{"type":"string","example":"Mon, 11 Aug 1986 00:00:00.000Z"},"workflowComment":{"type":"object","properties":{"date":{"type":"string","example":"Thu, 01 Jan 2099 00:00:00.000Z"},"comment":{"type":"string","example":"Approve content."},"commenter":{"type":"string","example":"wpsadmin"}}}}},"content":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"content":{"type":"object","properties":{"elements":{"type":"object","properties":{"element":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Example Component Reference"},"title":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"English"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string","example":"en"},"value":{"type":"string","example":"Example Component Reference Display Title"}}},"type":{"type":"string","example":"ReferenceComponent"},"data":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"PropertiesContent":{"type":"object","properties":{"type":{"type":"string","example":"application/vnd.ibm.wcm+xml"},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"HELP_TEXT_PROVIDER_NAME"},"value":{"type":"string","example":"NONE"}}}},"reference":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryMenuComponent/ec09ce29-d421-4064-b5ec-c4a4c642116d"},"date":{"type":"object","properties":{"type":{"type":"string","example":"DateTime"},"value":{"type":"string","example":"Tue, 11 Aug 2020 00:00:00.000Z"}}},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}},"value":{"type":"string","example":"

HCL Digital Experience

"},"image":{"type":"object","properties":{"dimension":{"type":"object","properties":{"height":{"type":"string","example":"1500"},"width":{"type":"string","example":"1500"},"border":{"type":"string","example":"0"}}},"altText":{"type":"string","example":""},"tagName":{"type":"string","example":""},"fileName":{"type":"string","example":"5kB-test-image.png"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"ebc24b4b-7e2c-42a6-bab7-b1b8488486a0"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"renditionList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"desktop"},"fileName":{"type":"string","example":"filename.png"},"resourceUri":{"type":"object","properties":{"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"/wps/wcm/myconnect/ebc24b4b-7e2c-42a6-bab7-b1b8488486a0/5kB-test-image.png?MOD=AJPERES"}}},"binaryresource":{"type":"object","properties":{"fileName":{"type":"string","example":"filename.png"},"type":{"type":"string","example":"image/png"},"value":{"type":"string","example":"base64"}}}}}}}},"jsp":{"type":"object","properties":{"path":{"type":"string","example":"/sample/path"},"errorMessage":{"type":"string","example":"sample errors"}}},"linkElement":{"type":"object","properties":{"destination":{"type":"object","properties":{"type":{"type":"string","example":"external"},"allowClear":{"type":"boolean","example":false},"value":{"type":"string","example":"https://www.hcl-software.com"}}},"display":{"type":"object","properties":{"type":{"type":"string","example":"image"},"value":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/wcmrest/LibraryImageComponent/cd39f201-3e41-4f13-8363-fb5d2301f92d"}}},"description":{"type":"object","properties":{"useDestination":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"target":{"type":"string","example":"None"},"additionalAttributes":{"type":"string","example":""}}},"double":{"type":"string","example":"1,000"},"optionselection":{"type":"object","properties":{"displaytype":{"type":"string","example":"Automatic"},"selection":{"type":"string","example":"UserDefined"},"options":{"type":"object","properties":{"mode":{"type":"string","example":"Multiselect"},"option":{"type":"array","items":{"type":"object","properties":{"selected":{"type":"boolean","example":true},"id":{"type":"string","example":"Red"},"value":{"type":"string","example":"Red"}}}}}}}},"userSelection":{"type":"object","properties":{"user":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=wpsadmin,o=defaultWIMFileBasedRealm"},"uri":{"type":"string","example":"/wps/mycontenthandler/!ut/p/digest!uKX-_1ZH17yLg1CZ5cVRRg/um/users/profiles/Z9eAeI1ECJP47N1E6JMCC3JC6MMG663PIJM07JHOAJM07HPD23H9C1RD83I16K1"},"name":{"type":"string","example":"wpsadmin"}}}}}},"file":{"type":"object","properties":{"fileName":{"type":"string","example":"5kB-test-document.pdf"},"resourceUri":{"type":"object","properties":{"damId":{"type":"string","example":"605092bc-9f12-4688-9fec-fa4ced30c550"},"type":{"type":"string","example":"application/pdf"},"value":{"type":"string","example":"/wps/wcm/myconnect/605092bc-9f12-4688-9fec-fa4ced30c550/5kB-test-document.pdf?MOD=AJPERES"}}}}}}}}}}}}}}}}}},"links":{"type":"object","properties":{"publish":{"type":"object","properties":{"href":{"type":"string","example":"/webcontent/contents/ad0490ea-27cb-4392-801b-5b559170e69e/workflow-action"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Publish"}}},"workflow":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/fa1f9585-6c40-4bfa-85cc-155c20567448/workflow"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow"}}},"workflowStage":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/3c2480d5-6a2d-4396-a3f3-cde6e5d34319/currentstage"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Workflow Stage"}}},"accessControl":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/access/current-user?resourceId=Z6QReDe13P03Q47G9P2MM86NPO4MMG6J9E4JM07G9C4MMK62BDAJS46N1CA6R4753"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Access Control"}}},"library":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/libraries/a1ce9683-5713-449b-ab30-7155a77225cb"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Library"}}},"parent":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/search?type=SiteArea&id=a5a4887c-ee1c-4723-8e92-12c77630f98d"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Parent"}}},"preview":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/contents/render/ad0490ea-27cb-4392-801b-5b559170e69e"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Preview"}}},"contentTemplate":{"type":"object","properties":{"href":{"type":"string","example":"/dxmyrest/webcontent/content-templates/8f572e31-3e97-4be0-9838-8a4449b89c36"},"lang":{"type":"string","example":"en"},"label":{"type":"string","example":"Content Template"}}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"object","properties":{"term":{"type":"string","example":"DRAFT"},"label":{"type":"string","example":"Draft"},"lang":{"type":"string","example":"en"}}},"favorite":{"type":"object","properties":{"term":{"type":"string","example":"true"},"lang":{"type":"string","example":"en"}}},"locked":{"type":"object","properties":{"term":{"type":"string","example":"false"},"label":{"type":"string","example":""}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"content_id","in":"path","description":"The ID of the content (e.g., 97d110f7-ab61-49d9-b9b2-de5322892f9c)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"filename","in":"query","description":"Boolean value to determine if whether to include the filename for file elements in the response.","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/contents":{"get":{"x-controller-name":"ContentController","x-operation-name":"contents","tags":["ContentController"],"operationId":"accessContents","security":[{"cookieAuth":[]}],"description":"This request returns a list of content items depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of contents.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/libraries/{library_id}/preset-folders":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"readLibraryPresetFolder","tags":["LibraryManagerController"],"operationId":"webContentReadLibraryPresetFolder","security":[{"cookieAuth":[]}],"description":"This request returns the preset folders that were automatically created when a library is created.","responses":{"200":{"description":"Returns the preset folders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"text":{"type":"string"}},"required":["lang","text"]},"updated":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","title","updated","name","type"]}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/libraries/{library_id}":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"readLibrary","tags":["LibraryManagerController"],"operationId":"webContentReadLibrary","security":[{"cookieAuth":[]}],"description":"This request returns a library's details.","responses":{"200":{"description":"Returns the library's details.","content":{"application/json":{"schema":{"type":"object","properties":{"xmlns":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"displayTitle":{"type":"string"},"titleTextProviderName":{"type":"string"},"titleTextProviderKey":{"type":"string"},"summary":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"link":{"type":"array","items":{"properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"}}}},"content":{"type":"object","properties":{"type":{"type":"string"},"library":{"type":"object","properties":{"xmlns":{"type":"string"},"allowDeletion":{"type":"boolean"},"enabled":{"type":"boolean"},"language":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"library_id","in":"path","description":"The ID of the library. (e.g., d22e3cad-635e-482a-8124-9d21da7bfd0a)","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/libraries":{"get":{"x-controller-name":"LibraryManagerController","x-operation-name":"libraries","tags":["LibraryManagerController"],"operationId":"accessLibraries","security":[{"cookieAuth":[]}],"description":"This request returns a list of libraries depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of libraries.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}}]}},"/{access_type}/webcontent/query-by-attribute":{"get":{"x-controller-name":"QueryController","x-operation-name":"getData","tags":["QueryController"],"operationId":"webContentQueryByAttribute","security":[{"cookieAuth":[]}],"description":"Note: This request will be deprecated soon. Please refer to 'GET /{access_type}/webcontent/search' for the same request functionality.","responses":{"200":{"description":"Returns the search results based on its search filter, sorting and pagination values","content":{"application/json":{"schema":{"type":"object","properties":{"feed":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"updated":{"type":"string"},"entry":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"#text":{"type":"string"}}},"summary":{"type":"object"},"updated":{"type":"string"},"category":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"#text":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"dx:distinguishedName":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/recent-items":{"get":{"x-controller-name":"RecentItemsController","x-operation-name":"getRecentItems","tags":["RecentItemsController"],"operationId":"getRecentItems","security":[{"cookieAuth":[]}],"description":"This request returns a list of recently accessed items.","responses":{"200":{"description":"Returns a list of recently accessed items.","content":{"application/json":{"schema":{"type":"object","properties":{"self":{"type":"string"},"first":{"type":"string"},"next":{"type":"string"},"last":{"type":"string"},"contents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}},"required":["lang","value"]},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastAccessed":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]}},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}},"required":["distinguishedName","name"]},"link":{"type":"object","properties":{"rel":{"type":"object","properties":{"href":{"type":"string"},"lang":{"type":"string"},"label":{"type":"string"}}}}},"category":{"type":"object","properties":{"scheme":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}},"required":["id","title","summary","name","type","updated","lastModifier","link","category"]}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"type","in":"query","description":"This parameter is used to query items of a specific item type.","schema":{"type":"array","items":{"type":"string","enum":["Category","Content","ContentTemplate","CustomWorkflowAction","DateComponent","EmailAction","ExpireAction","FileComponent","Folder","HTMLComponent","ImageComponent","JSPComponent","Library","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","LibraryReferenceComponent","LibraryLinkComponent","LibraryTaxonomyComponent","NumericComponent","OptionSelectionComponent","PortalPage","PresentationTemplate","Project","ProjectTemplate","PublishAction","RichTextComponent","ScheduledMoveAction","ShortTextComponent","SiteArea","SiteAreaTemplate","Taxonomy","TextComponent","UserSelectionComponent","VersionAction","Workflow","WorkflowAction","WorkflowStage"]}}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. The values _ascending or _descending are appended to the query to determine sort order. If _ascending or _descending are not specified, the results as displayed in ascending order.","schema":{"type":"string","enum":["accessed_ascending","accessed_descending","author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","title_ascending","title_descending"],"example":"created_ascending"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display. For example, if pagesize is set to 5, and the page parameter is set to 2, then only results 6 to 10 will be displayed.","schema":{"type":"number"}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items returned by a query to a set number. It can be used with the page parameter to return specific pages of results.","schema":{"type":"number"}}]}},"/{access_type}/webcontent/references":{"get":{"x-controller-name":"QueryController","x-operation-name":"getReferences","tags":["QueryController"],"operationId":"webContentGetReferences","security":[{"cookieAuth":[]}],"description":"This request returns a list of content items which references 'itemid'. 'itemid' is any resource ID like content template ID or workflow ID.","responses":{"200":{"description":"Returns the list of content items which references 'itemid'.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"author":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}}},"categories":{"type":"object","properties":{"workflowState":{"type":"array","items":{"type":"object","properties":{"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}},"path":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"type":{"type":"string"}}}},"link":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"itemId","in":"query","description":"The ID of an item whose references has to be fetched. (e.g., 8d25860b-7a5c-4015-9cd5-bdcc60ce14bb).","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Reference type. Pass wcm or dam to fetch the wcm or dam references correspondingly for an item id","required":true,"schema":{"type":"string","enum":["wcm","dam"],"example":"wcm"}},{"name":"page","in":"query","description":"This parameter is used to return specific pages of results. default is 1","schema":{"type":"number"}},{"name":"pageSize","in":"query","description":"This parameter is used to restrict the number of items returned by a query to a set number. default is 10","schema":{"type":"number"}}]}},"/{access_type}/webcontent/search":{"get":{"x-controller-name":"QueryController","x-operation-name":"search","tags":["QueryController"],"operationId":"webContentSearch","security":[{"cookieAuth":[]}],"description":"This request returns a search results based on its search filters, sorting and pagination values.","responses":{"200":{"description":"Returns the search results based on its search filter, sorting and pagination values.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"type","in":"query","description":"This parameter is used to query items of a specific item type. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["Category","Content","ContentTemplate","CustomWorkflowAction","DateComponent","EmailAction","ExpireAction","FileComponent","Folder","HTMLComponent","ImageComponent","JSPComponent","Library","LibraryAuthoringToolsComponent","LibraryDateComponent","LibraryFileComponent","LibraryHTMLComponent","LibraryImageComponent","LibraryJSPComponent","LibraryListPresentationComponent","LibraryMenuComponent","LibraryNavigatorComponent","LibraryNumericComponent","LibraryPageNavigationComponent","LibraryPersonalizationComponent","LibraryRichTextComponent","LibrarySearchComponent","LibraryShortTextComponent","LibraryStyleSheetComponent","LibraryTextComponent","LibraryUserNameComponent","LibraryUserSelectionComponent","LibraryReferenceComponent","LibraryLinkComponent","LibraryTaxonomyComponent","NumericComponent","OptionSelectionComponent","PortalPage","PresentationTemplate","Project","ProjectTemplate","PublishAction","RichTextComponent","ScheduledMoveAction","ShortTextComponent","SiteArea","SiteAreaTemplate","Taxonomy","TextComponent","UserSelectionComponent","VersionAction","Workflow","WorkflowAction","WorkflowStage"]}}},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"filteraccess","in":"query","description":"Using the Search API, this parameter is used to filter access control roles. All other parameters, such as parentID or type, remain valid, allowing one to, for example, locate all libraries on which the user has the Editor role. User, Editor, Admin, Manager, and Contributor are all valid roles.","schema":{"type":"string"}},{"name":"depth","in":"query","description":"This parameter is used with the parentid and is used to define whether to search for all descendants of a parent, or just the immediate children of a parent item (e.g., to query only the immediate children of an item, you select CHILDREN, to query all descendants of an item, you select DESCENDANTS).","schema":{"type":"string","enum":["CHILDREN","DESCENDANTS"]}},{"name":"dateFormat","in":"query","description":"This parameter is used to define the date format of query parameters (e.g., mm-dd-yyyy. If a date format is not specified, then the default format yyyy-MM-dd'T'HH:mm:ssz is used).","schema":{"type":"string"}},{"name":"title","in":"query","description":"This parameter is used to query an item with a specific title.","schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","description":"This parameter is used to query an item with a specific name.","schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"query","description":"This parameter is used to query an item with a specific ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"keyword","in":"query","description":"This parameter is used to query items that are profiled with a specific keyword.","schema":{"type":"array","items":{"type":"string"}}},{"name":"creator","in":"query","description":"This parameter is used to query items with a specific creator. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"lastModifier","in":"query","description":"This parameter is used to query items that were last modified by a specific user. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"author","in":"query","description":"This parameter is used to query items with a specific author. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"owner","in":"query","description":"This parameter is used to query items with a specific owner. A user UID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"approver","in":"query","description":"This parameter is used to query items with a specific approver. A user ID must be specified when this parameter is used (e.g., uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm).","schema":{"type":"array","items":{"type":"string"}}},{"name":"state","in":"query","description":"This parameter is used to query items that are in a specific state. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["DRAFT","EXPIRED","PUBLISHED"]}}},{"name":"projectState","in":"query","description":"This parameter is used to query items that are linked to a project with a specific state. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["ACTIVE","PENDING","PUBLISHED","PUBLISHED_FAILED","PUBLISHING","SYNDICATING"]}}},{"name":"authoringTemplateID","in":"query","description":"This parameter is used to query items with a specific authoring template ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectID","in":"query","description":"This parameter is used to query items that are linked to a specific project (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"workflowID","in":"query","description":"This parameter is used to query items that use a specific workflow (e.g., 8d25860b-7a5c-4015-9cd5-bdcc60ce14bb).","schema":{"type":"array","items":{"type":"string"}}},{"name":"workflowStageID","in":"query","description":"This parameter is used to query items that are currently active within a specific workflow stage (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"categoryID","in":"query","description":"This parameter is used to query items with a specific category ID (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"string"}},{"name":"createdBefore","in":"query","description":"This parameter is used to query items that are created before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"createdAfter","in":"query","description":"This parameter is used to query items that are created after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"lastModifiedBefore","in":"query","description":"This parameter is used to query items that were last modified before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"lastModifiedAfter","in":"query","description":"This parameter is used to query items that were last modified after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"publishedBefore","in":"query","description":"This parameter is used to query items that are published before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"publishedAfter","in":"query","description":"This parameter is used to query items that are published after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"expiredBefore","in":"query","description":"This parameter is used to query items that were expired before a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}},{"name":"expiredAfter","in":"query","description":"This parameter is used to query items that were expired after a specific date and time (e.g., 2011-01-11T11:43:29.0150Z).","schema":{"type":"string"}}]}},"/{access_type}/webcontent/site-areas":{"get":{"x-controller-name":"SiteAreaController","x-operation-name":"siteAreas","tags":["SiteAreaController"],"operationId":"accessSiteAreas","security":[{"cookieAuth":[]}],"description":"This request returns a list of site areas depending on the search filters and pagination values.","responses":{"200":{"description":"Returns a list of all site areas.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflow-actions":{"get":{"x-controller-name":"WorkflowManagerController","x-operation-name":"workflowActions","tags":["WorkflowManagerController"],"operationId":"accessWorkflowActions","security":[{"cookieAuth":[]}],"description":"This request returns all the workflow actions.","responses":{"200":{"description":"Returns a list of all workflow actions.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflow-stages/{workflow_stage_id}":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStage","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStage","security":[{"cookieAuth":[]}],"description":"This request returns a workflow stage details.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"actions":{"type":"object","properties":{"entering":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_stage_id","in":"path","description":"The ID of a workflow stage.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflow-stages":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"workflowStages","tags":["WorkflowStageController"],"operationId":"accessWorkflowStages","security":[{"cookieAuth":[]}],"description":"This request returns all available workflow stages.","responses":{"200":{"description":"Returns a list of all the workflow stages.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}},"/{access_type}/webcontent/workflows/{workflow_id}/workflow-stages":{"get":{"x-controller-name":"WorkflowStageController","x-operation-name":"readWorkflowStagesInWorkflow","tags":["WorkflowStageController"],"operationId":"webContentReadWorkflowStagesInWorkflow","security":[{"cookieAuth":[]}],"description":"This request returns all the workflow stages of a workflow.","responses":{"200":{"description":"Returns a workflow-stage's details.","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"},"total":{"type":"integer"},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflowStage":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"jointApproval":{"type":"object","properties":{"enabled":{"type":"boolean"},"approver":{"type":"array","items":{"type":"object","properties":{"distinguishedName":{"type":"string"},"name":{"type":"string"}}}}}},"workflowDefinedAccess":{"type":"object","properties":{"role":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"inheritance":{"type":"boolean"},"propagation":{"type":"boolean"}}}}}}}}}},"position":{"type":"integer"}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_id","in":"path","description":"The ID of a workflow.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflows/{workflow_id}":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"readWorkflow","tags":["WorkflowController"],"operationId":"webContentReadWorkflow","security":[{"cookieAuth":[]}],"description":"This request returns the details of a workflow.","responses":{"200":{"description":"Returns the workflow's details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"created":{"type":"string"},"author":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}}},"owner":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"lastModifier":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"distinguishedName":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}},"content":{"type":"object","properties":{"workflow":{"type":"object","properties":{"option":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"}}}},"stage":{"type":"object","properties":{"stages":{"type":"array","items":{"properties":{"index":{"type":"string"},"id":{"type":"string"}}}}}},"draftCreation":{"type":"string"}}}}}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"403":{"description":"Returns a status 403 - Forbidden error. Check for out of scope user roles or permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"workflow_id","in":"path","description":"The ID of a workflow.","schema":{"type":"string"},"required":true},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true}]}},"/{access_type}/webcontent/workflows":{"get":{"x-controller-name":"WorkflowController","x-operation-name":"workflows","tags":["WorkflowController"],"operationId":"accessWorkflows","security":[{"cookieAuth":[]}],"description":"This request returns all the available workflows.","responses":{"200":{"description":"Returns a list of a the workflows.","content":{"application/json":{"schema":{"type":"object","required":["self","first"],"properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"contents":{"type":"array","items":{"type":"object","required":["id","title","summary","type","updated"],"properties":{"id":{"type":"string"},"title":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"displayTitle":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"summary":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"description":{"type":"object","properties":{"lang":{"type":"string"},"value":{"type":"string"}}},"name":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string"},"lastModifier":{"type":"object","properties":{"distinguishedName":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"term":{"type":"string"},"label":{"type":"string"},"lang":{"type":"string"}}}}}}},"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}}}}},"400":{"description":"Returns status 400 - Bad Request. It is a client side error that may be a result of either JSON format error or request data validation error. (e.g., input parameters are missing or invalid).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"401":{"description":"Returns a status 401 - Unauthorized error. Usually the user is not authenticated or logged in or the authentication token is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"404":{"description":"Returns a status 404 - Not Found error. Usually if the resource is not found or if there is a mistyped endpoints.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}},"422":{"description":"Returns status 422 - Unprocessable Entity error. Status 400 is usually used in place of this error status in the case the request data failed the validations.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"name":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}},"500":{"description":"Returns status 500 - Internal Server Error. This an unexpected error which was not handled on the server side, usually an undefined or null error, or a promise rejection error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"parameters":[{"name":"Cookie","in":"header","description":"Contains the access or authentication token. Leave this field empty if you are already authenticated, unless you intend to put a token value.","schema":{"type":"string"}},{"name":"virtualportal","in":"query","description":"The virtual portal name, if any, to which this request will be applied, otherwise leave this field empty.","schema":{"type":"string"}},{"name":"access_type","in":"path","description":"The access type of the user. Authenticated users should use 'dxmyrest', and an unauthenticated users should use 'dxrest'.","schema":{"type":"string","enum":["dxrest","dxmyrest"],"example":"dxmyrest"},"required":true},{"name":"limit","in":"query","description":"This parameter is used to restrict the number of items that are returned by a request to a set number. It can be used with the page parameter to return specific pages of the results (default value is 100). (e.g., to restrict the number of queries to be returned to 5, set limit to 5).","schema":{"type":"string"}},{"name":"page","in":"query","description":"This parameter is used with the pagesize parameter to define what set of results to display (e.g., if pagesize is set to 5, and the page parameter is set to 2, then only results 6 - 10 are displayed).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter is appended to queries to determine how query results are sorted. Multiple options can be selected.","schema":{"type":"array","items":{"type":"string","enum":["author_ascending","author_descending","created_ascending","created_descending","modified_ascending","modified_descending","name_ascending","name_descending","parents_ascending","parents_descending","position_ascending","position_descending","title_ascending","title_descending"]}}},{"name":"titleLike","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with titles like the specified titlelike parameter while ignoring the letter case (e.g., titleApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLike","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"nameLikeIgnoreCase","in":"query","description":"This parameter is used as a wildcard query for items with names like the specified namelike parameter while ignoring the letter case (e.g., nameApproxValue%).","schema":{"type":"array","items":{"type":"string"}}},{"name":"titleOrNameLike","in":"query","description":"This parameter is used to join the query results of nameLike, nameLikeIgnoreCase, titleLike, and titleLikeIgnoreCase (e.g., true).","schema":{"type":"boolean"}},{"name":"libraryID","in":"query","description":"This parameter is used to query items that are stored in a specific library (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}},{"name":"parentID","in":"query","description":"This parameter is used to query items that are the children of a specific parent item (e.g., 18cfc80c-a490-4d75-9057-fed3db89de53).","schema":{"type":"array","items":{"type":"string"}}}]}}},"components":{"securitySchemes":{"cookieAuth":{"description":"LtpaToke2 is going to identifying the user session.","type":"apiKey","in":"cookie","name":"LtpaToken2"}}},"servers":[{"url":"/dx/api/core/v1"}]} \ No newline at end of file diff --git a/search-v2-api/openapi.json b/search-v2-api/openapi.json index 4b24151..a9518c7 100644 --- a/search-v2-api/openapi.json +++ b/search-v2-api/openapi.json @@ -37,6 +37,15 @@ "schema": { "type": "string" } + }, + { + "name": "aclLookupPathFilter", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "filter by aclLookupPath", + "in": "query", + "schema": { + "type": "string" + } } ], "responses": { @@ -51,13 +60,9 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] }, "post": { "summary": "postContentSources tries to create an OpenSearch document and index from the given name, type and aclLookupHost as parameter.", @@ -80,7 +85,7 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], "security": [ { @@ -119,13 +124,9 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] }, "post": { "summary": "postContentSources tries to create an OpenSearch document and index from the given name, type and aclLookupHost as parameter.", @@ -159,7 +160,7 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], "security": [ { @@ -248,7 +249,7 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], "security": [ { @@ -333,7 +334,7 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], "security": [ { @@ -359,6 +360,9 @@ "200": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" }, + "204": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source element deleted." + }, "400": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Unable to delete Content Source element" }, @@ -373,7 +377,7 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], "security": [ { @@ -386,10 +390,25 @@ "get": { "summary": "getContentSourceTypes", "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists all content-source types.", + "parameters": [ + { + "name": "showFieldMappings", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Returns the field mappings for each type of Content Source.", + "example": false, + "in": "query", + "schema": { + "type": "boolean" + } + } + ], "responses": { "200": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Invalid request parameters" + }, "401": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" }, @@ -398,13 +417,9 @@ } }, "tags": [ - "ContentSource (protected)" + "ContentSource" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] } }, "/crawlers": { @@ -426,7 +441,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -509,7 +524,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -548,7 +563,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -571,56 +586,7 @@ } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contentSource": { - "type": "string", - "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" - }, - "type": { - "type": "string", - "example": "wcm" - }, - "configuration": { - "type": "object", - "properties": { - "targetDataSource": { - "type": "string" - }, - "schedule": { - "type": "* 2 * * *" - }, - "security": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "basic" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "maxCrawlTime": { - "type": "number" - }, - "maxRequestTime": { - "type": "number" - } - } - } - } - } - } - }, - "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + "$ref": "#/components/requestBodies/Data2" }, "responses": { "200": { @@ -637,7 +603,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -660,56 +626,7 @@ } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contentSource": { - "type": "string", - "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" - }, - "type": { - "type": "string", - "example": "wcm" - }, - "configuration": { - "type": "object", - "properties": { - "targetDataSource": { - "type": "string" - }, - "schedule": { - "type": "string" - }, - "security": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "basic" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "maxCrawlTime": { - "type": "number" - }, - "maxRequestTime": { - "type": "number" - } - } - } - } - } - } - }, - "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + "$ref": "#/components/requestBodies/Data2" }, "responses": { "200": { @@ -726,7 +643,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -752,6 +669,9 @@ "200": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" }, + "204": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler deleted." + }, "401": { "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" }, @@ -763,7 +683,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -802,7 +722,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -824,6 +744,15 @@ "schema": { "type": "string" } + }, + { + "name": "clear_timestamp", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Clear the timestamp and trigger the crawler", + "in": "query", + "schema": { + "type": "boolean" + } } ], "responses": { @@ -841,7 +770,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -880,7 +809,7 @@ } }, "tags": [ - "Crawlers (protected)" + "Crawlers" ], "security": [ { @@ -892,7 +821,7 @@ "/contentsources/{contentsource_id}/documents": { "get": { "summary": "Get document ids from index given as contentsource_id (getContentsourcesDocuments)", - "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists document ids and their title from content source index with given ID.", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists document ids from content source index with given ID.", "parameters": [ { "name": "contentsource_id", @@ -937,7 +866,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1061,7 +990,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1180,7 +1109,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1304,7 +1233,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1327,7 +1256,7 @@ } ], "requestBody": { - "$ref": "#/components/requestBodies/Data2" + "$ref": "#/components/requestBodies/Data3" }, "responses": { "200": { @@ -1347,7 +1276,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1372,7 +1301,7 @@ } ], "requestBody": { - "$ref": "#/components/requestBodies/Data2" + "$ref": "#/components/requestBodies/Data3" }, "responses": { "200": { @@ -1392,7 +1321,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1453,7 +1382,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1504,7 +1433,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1630,7 +1559,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1753,7 +1682,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1866,7 +1795,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1918,7 +1847,7 @@ } }, "tags": [ - "ContentPush (protected)" + "ContentPush" ], "security": [ { @@ -1932,7 +1861,7 @@ "summary": "postSearch", "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns documents and aggregations. \n The query object is formed with a \"must\", \"should\" and/or \"must_not\" array of objects and\n an optional minimum_should_match property.\n It follows the standard OpenSearch Query structure.\n The aggregations object follows the same OpenSearch Aggregation structure.\n The page (default: 0) and pageSize (default: 100) parameters are optional.\n The scope parameter is an array of Content Source UUIDs to filter the search results.\n If the scope parameter is not provided, the search will be performed on all available Content Sources", "requestBody": { - "$ref": "#/components/requestBodies/Data3" + "$ref": "#/components/requestBodies/Data4" }, "responses": { "200": { @@ -1948,11 +1877,7 @@ "tags": [ "ContentQuery" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] } }, "/mysearch": { @@ -1960,7 +1885,7 @@ "summary": "postMySearch", "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns documents and aggregations. \n The query object is formed with a \"must\", \"should\" and/or \"must_not\" array of objects and\n an optional minimum_should_match property.\n It follows the standard OpenSearch Query structure.\n The aggregations object follows the same OpenSearch Aggregation structure.\n The page (default: 0) and pageSize (default: 100) parameters are optional.\n The scope parameter is an array of Content Source UUIDs to narrow down the search results.\n If the scope parameter is not provided, the search will be performed on all available Content Sources", "requestBody": { - "$ref": "#/components/requestBodies/Data3" + "$ref": "#/components/requestBodies/Data4" }, "responses": { "200": { @@ -1976,11 +1901,7 @@ "tags": [ "ContentQuery" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] } }, "/admin/authenticate": { @@ -2025,11 +1946,7 @@ "tags": [ "Authentication" ], - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [] } } }, @@ -2099,6 +2016,58 @@ "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" }, "Data2": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contentSource": { + "type": "string", + "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "configuration": { + "type": "object", + "properties": { + "targetDataSource": { + "type": "string" + }, + "schedule": { + "type": "string" + }, + "security": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "basic" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "maxCrawlTime": { + "type": "number" + }, + "maxRequestTime": { + "type": "number" + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "Data3": { "content": { "application/json": { "schema": { @@ -2120,7 +2089,7 @@ }, "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" }, - "Data3": { + "Data4": { "content": { "application/json": { "schema": { diff --git a/wcm-api/openapi.json b/wcm-api/openapi.json index fde008f..62a233c 100644 --- a/wcm-api/openapi.json +++ b/wcm-api/openapi.json @@ -3748,6 +3748,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -4063,6 +4073,14 @@ }, "in": "path", "required": true + }, + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" } ], "responses": { @@ -4376,6 +4394,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -4673,6 +4701,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -4970,6 +5008,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -5273,6 +5321,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -5571,6 +5629,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -5870,6 +5938,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -6166,6 +6244,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -6461,6 +6549,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -6742,6 +6840,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -7038,6 +7146,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -7333,6 +7451,16 @@ "tags": [ "Component" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -10920,6 +11048,16 @@ "tags": [ "Presentation Template" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -11230,6 +11368,16 @@ "tags": [ "Project" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -13238,6 +13386,16 @@ "tags": [ "Site Area Template" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -14289,6 +14447,16 @@ "tags": [ "Workflow" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -14587,6 +14755,16 @@ "tags": [ "Workflow" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -14886,6 +15064,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -15432,6 +15620,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -15720,6 +15918,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -16008,6 +16216,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -16296,6 +16514,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": { @@ -16584,6 +16812,16 @@ "tags": [ "Workflow Action" ], + "parameters": [ + { + "name": "USE_LINKS", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Return the response object with a plural name of links instead of link to be consistent with PUT and other APIs.", + "schema": { + "type": "boolean" + }, + "in": "query" + } + ], "responses": { "200": { "content": {