{"openapi":"3.0.1","info":{"title":"SEO","description":"BS App SEO API.\n <b><h1>Deprecated endpoints:</h1></b><table border=\"1px;\"><tr><th style=\"text-align: center; vertical-align: middle;\"><b><h3>Uri</b></h3></th><th><b>Method</b></th><th><b><h3>Since</h3></b></th><th><b><h3>End of life</h3></b></th></tr></table>","version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/seo"}],"tags":[{"name":"Technical","description":"To get technical information."},{"name":"Metadata","description":"update metadata to Papi Sync"},{"name":"Content Management","description":"API endpoints for managing the content management system (CMS).","x-Authorizations":{"OAuth2":"implicit_scope"}},{"name":"Campaigns","description":"API operations for campaigns."},{"name":"Categories","description":"API operations for categories."},{"name":"Contents","description":"API operations for contents."},{"name":"Settings","description":"API endpoints for managing SEO settings.","x-Authorizations":{"OAuth2":"implicit_scope"}},{"name":"Products","description":"API operations for products."},{"name":"Recovery","description":"API operations for recovery."},{"name":"SEFUrls","description":"API operations for SEFUrls."}],"paths":{"/technical/version":{"get":{"tags":["Technical"],"summary":"Show service version.","operationId":"presentVersion","responses":{"200":{"description":"Show service version."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/metadata/jobs/{id}":{"get":{"tags":["Metadata"],"summary":"Get Metadata job","operationId":"getMetadataJobById","parameters":[{"name":"id","in":"path","description":"MetadataJob ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata Job by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get Metadata Job"}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/metadata":{"post":{"tags":["Metadata"],"summary":"Post all products/categories seo as metadata to Papi Sync","operationId":"pushAllMetadata","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushAllMetadataRequest"}}},"required":true},"responses":{"201":{"description":"Registered Push-All job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataJobResponse"}}}},"202":{"description":"Found a running Push-All job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Cannot process request","content":{"application/json":{}}}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/metadata/jobs":{"get":{"tags":["Metadata"],"summary":"Get Metadata job","operationId":"searchMetadataJob","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"type":"integer","format":"int32","default":20}},{"name":"sortReverse","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"sortKey","in":"query","schema":{"type":"string","default":"createdAt"}}],"responses":{"200":{"description":"Metadata Job listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/cms/publish/{canonicalId}":{"put":{"tags":["Content Management"],"summary":"Generate SEF after publishing CMS.","description":"This endpoint generates a SEFUrl after publishing the CMS.","operationId":"publishCMS","parameters":[{"name":"canonicalId","in":"path","description":"Canonical ID (Content ID).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A SEF URL is updated."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/cms/unpublish/{canonicalId}":{"put":{"tags":["Content Management"],"summary":"Delete SEF after unpublishing CMS.","description":"This endpoint deletes a SEF URL after unpublishing the content management system (CMS).","operationId":"unpublishCMS","parameters":[{"name":"canonicalId","in":"path","description":"Canonical ID (Content ID).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The SEF URL has been successfully deleted."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/campaigns/{id}/seo":{"get":{"tags":["Campaigns"],"summary":"List campaigns sefurl.","description":"Lists all SEF URL of campaigns.","operationId":"listCampaignSefUrls","parameters":[{"name":"id","in":"path","description":"Campaign ID.","required":true,"schema":{"type":"string"}},{"name":"publishedSefUrl","in":"query","description":"Published SEF URL (true = only published , false = only unpublished , null = get both)","schema":{"type":"boolean"}},{"name":"activeSefUrl","in":"query","description":"Active SEF URL (true = only acive, false = only historical, null = get both)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The campaign SEF URLs are successfully listed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSeoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Campaign SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/campaigns/{id}/metaInformation":{"put":{"tags":["Campaigns"],"summary":"Update meta information.","operationId":"updateMetaInformation","parameters":[{"name":"id","in":"path","description":"Campaign ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaInformationRequest"}}},"required":true},"responses":{"201":{"description":"Metadata updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Campaign SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/campaigns/{id}/openGraphInformation":{"put":{"tags":["Campaigns"],"summary":"Update open graph information.","operationId":"updateOpenGraphInformation","parameters":[{"name":"id","in":"path","description":"Campaign ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenGraphInformationRequest"}}},"required":true},"responses":{"201":{"description":"Open graph information updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Campaign SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/categories/{id}/seo":{"get":{"tags":["Categories"],"summary":"List categories sefurl.","description":"Lists all SEF URL of categories.","operationId":"listCategorySefUrls","parameters":[{"name":"id","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}},{"name":"publishedSefUrl","in":"query","description":"Published SEF URL (true = only published , false = only unpublished , null = get both)","schema":{"type":"boolean"}},{"name":"activeSefUrl","in":"query","description":"Active SEF URL (true = only acive, false = only historical, null = get both)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The category SEF URLs are successfully listed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSeoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/categories/{id}/metaInformation":{"put":{"tags":["Categories"],"summary":"Update meta information.","operationId":"updateMetaInformation_1","parameters":[{"name":"id","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaInformationRequest"}}},"required":true},"responses":{"201":{"description":"Metadata updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/categories/{id}/openGraphInformation":{"put":{"tags":["Categories"],"summary":"Update open graph information.","operationId":"updateOpenGraphInformation_1","parameters":[{"name":"id","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenGraphInformationRequest"}}},"required":true},"responses":{"201":{"description":"Open graph information updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/contents/{id}/seo":{"get":{"tags":["Contents"],"summary":"List contents sefurl.","description":"Lists all SEF URL of contents.","operationId":"listContentSefUrls","parameters":[{"name":"id","in":"path","description":"Content ID.","required":true,"schema":{"type":"string"}},{"name":"publishedSefUrl","in":"query","description":"Published SEF URL (true = only published , false = only unpublished , null = get both)","schema":{"type":"boolean"}},{"name":"activeSefUrl","in":"query","description":"Active SEF URL (true = only acive, false = only historical, null = get both)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The content SEF URLs are successfully listed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSeoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Content SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/contents/{id}/metaInformation":{"put":{"tags":["Contents"],"summary":"Update meta information.","operationId":"updateMetaInformation_2","parameters":[{"name":"id","in":"path","description":"Content ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaInformationRequest"}}},"required":true},"responses":{"201":{"description":"Metadata updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Content SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/contents/{id}/openGraphInformation":{"put":{"tags":["Contents"],"summary":"Update open graph information.","operationId":"updateOpenGraphInformation_2","parameters":[{"name":"id","in":"path","description":"Content ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenGraphInformationRequest"}}},"required":true},"responses":{"201":{"description":"Open graph information updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Content SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/settings":{"get":{"tags":["Settings"],"summary":"Get a Field Setting Object.","operationId":"getFieldSetting","responses":{"200":{"description":"A Field Setting Object is retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The Field Setting Object is not found."}},"security":[{"oauth2":[]}]},"put":{"tags":["Settings"],"summary":"Update a field setting.","operationId":"updateFieldSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingRequest"}}},"required":true},"responses":{"200":{"description":"The field setting has been successfully updated."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Settings"],"summary":"Create a field setting.","operationId":"createFieldSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingRequest"}}},"required":true},"responses":{"201":{"description":"The field setting has been successfully created."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Settings"],"summary":"Delete a field setting.","operationId":"deleteFieldSetting","responses":{"200":{"description":"The field setting has been successfully deleted."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/products/{id}/seo":{"get":{"tags":["Products"],"summary":"List products sefurl.","description":"Lists all SEF URL of products.","operationId":"listProductSefUrls","parameters":[{"name":"id","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}},{"name":"publishedSefUrl","in":"query","description":"Published SEF URL (true = only published , false = only unpublished , null = get both)","schema":{"type":"boolean"}},{"name":"activeSefUrl","in":"query","description":"Active SEF URL (true = only acive, false = only historical, null = get both)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The product SEF URLs are successfully listed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSeoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/products/{id}/metaInformation":{"put":{"tags":["Products"],"summary":"Update meta information.","operationId":"updateMetaInformation_3","parameters":[{"name":"id","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaInformationRequest"}}},"required":true},"responses":{"201":{"description":"Metadata updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/products/{id}/openGraphInformation":{"put":{"tags":["Products"],"summary":"Update open graph information.","operationId":"updateOpenGraphInformation_3","parameters":[{"name":"id","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenGraphInformationRequest"}}},"required":true},"responses":{"201":{"description":"Open graph information updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product SEF URLs not found."}},"security":[{"oauth2":[]}]}},"/recovery/products/publish":{"post":{"tags":["Recovery"],"summary":"Force publish SEF.","operationId":"forcePublishSEF","responses":{"200":{"description":"The force publish operation has been invoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NormalResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/recovery/generateSEFUrlsJobs":{"get":{"tags":["Recovery"],"summary":"Get all generate SEF URLs jobs","operationId":"generateSEFUrlsJobs","parameters":[{"name":"page","in":"query","description":"Page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"status","in":"query","description":"Job status","schema":{"type":"string","enum":["IN_PROGRESS","FAILED","DONE"]}}],"responses":{"200":{"description":"The operation to fetch all generate SEF URLs jobs has been invoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGenerateSEFUrlJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Recovery"],"summary":"Trigger generate all SEF URLs job","operationId":"generateSEFUrls","parameters":[{"name":"context","in":"header","description":"Context","schema":{"type":"string"},"example":"en"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSEFListRequest"}}}},"responses":{"201":{"description":"The operation to run generate all SEF URLs job has been invoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSEFUrlJob"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/recovery/generateSEFUrlsJobs/{id}":{"get":{"tags":["Recovery"],"summary":"Get generate SEF URLs jobs","operationId":"generateSEFUrlsJobById","parameters":[{"name":"id","in":"path","description":"Job Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The operation to fetch generate SEF URLs job by id has been invoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSEFUrlJob"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Generate SEF URLs job not found."}},"security":[{"oauth2":[]}]},"put":{"tags":["Recovery"],"summary":"Update generate SEF URLs jobs","operationId":"updateGenerateSEFUrlsJob","parameters":[{"name":"id","in":"path","description":"Job Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGenerateSEFUrlsJobRequest"}}}},"responses":{"200":{"description":"The operation to update generate SEF URLs job by id has been invoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSEFUrlJob"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Generate SEF URLs job not found."}},"security":[{"oauth2":[]}]}},"/recovery/products/updateIncorrectSefUrl":{"post":{"tags":["Recovery"],"summary":"Move active Sef URL with a path that no longer exists to historical url.","operationId":"updateIncorrectSefUrl","responses":{"204":{"description":"The operation to fix SEF URL has been invoked."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/sefurls/{id}/history":{"post":{"tags":["SEFUrls"],"summary":"Create historical by SEF ID.","operationId":"createHistoryBySefId","parameters":[{"name":"id","in":"path","description":"SEF ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryRequest"}}},"required":true},"responses":{"201":{"description":"Create historical successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/sefurls/{id}/history/{historyId}":{"delete":{"tags":["SEFUrls"],"summary":"Delete historical by SEF ID.","operationId":"deleteHistoryBySefId","parameters":[{"name":"id","in":"path","description":"SEF ID.","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete historical successful."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"SEF URL not found."}},"security":[{"oauth2":[]}]}},"/sefurls/{id}":{"get":{"tags":["SEFUrls"],"summary":"Get Sef URL by ID.","operationId":"getSefById","parameters":[{"name":"id","in":"path","description":"SEF URL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get SEF URL successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SefUrlWithMetaResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"SEF URL not found."}},"security":[{"oauth2":[]}]},"put":{"tags":["SEFUrls"],"summary":"Update SEF URL.","operationId":"updateSefById","parameters":[{"name":"id","in":"path","description":"SEF ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSefUrlRequest"}}},"required":true},"responses":{"200":{"description":"Update SEF URL successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SefUrlWithMetaResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"SEF URL not found."}},"security":[{"oauth2":[]}]},"delete":{"tags":["SEFUrls"],"summary":"Delete Sef URL.","operationId":"deleteSefById","parameters":[{"name":"id","in":"path","description":"SEF ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete SEF URL successful."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"SEF URL not found."}},"security":[{"oauth2":[]}]}},"/sefurls/resolve/{fullUrl}":{"get":{"tags":["SEFUrls"],"summary":"Get an entire published SEF object.","description":"Retrieves the SEF object for the given URL.","operationId":"getSefUrl","parameters":[{"name":"fullUrl","in":"path","description":"Full SEF URL.","required":true,"schema":{"pattern":"(.+)?","type":"string"}}],"responses":{"200":{"description":"The SEF object is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"301":{"description":"An archived SEF object is retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The given URL is not found."}},"security":[{"oauth2":[]}]}},"/sefurls":{"get":{"tags":["SEFUrls"],"summary":"List published SEF objects by type.","operationId":"listSEFUrls","parameters":[{"name":"type","in":"query","description":"SEF type.","required":true,"schema":{"type":"string","enum":["CATEGORY","PRODUCT","CMS","CAMPAIGN"]}},{"name":"getMetadata","in":"query","description":"Get meta data.","required":true,"schema":{"type":"boolean","default":false}},{"name":"pageNo","in":"query","description":"Page Number.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"The list of published SEF objects is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/sefurls/url":{"post":{"tags":["SEFUrls"],"summary":"List of canonicalIds and corresponding SEF URLs.","operationId":"postListSefUrl","parameters":[{"name":"completeData","in":"query","description":"Complete data.","required":true,"schema":{"type":"boolean","default":false}},{"name":"sortField","in":"query","description":"Sort field.","schema":{"type":"string","default":"id"}},{"name":"sort","in":"query","description":"Sort.","schema":{"type":"string","default":"asc"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostListSefUrlRequest"}}},"required":true},"responses":{"200":{"description":"The list of SEF URLs is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSEFUrlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/sefurls/validate":{"get":{"tags":["SEFUrls"],"summary":"Validate SEF URL for duplicates with the current unpublished SEF.","operationId":"validateSef","parameters":[{"name":"sefUrl","in":"query","description":"SEF URL.","schema":{"type":"string"}}],"responses":{"200":{"description":"Validation successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SefUrlValidateResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Validation failed."}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"status":{"title":"Error status code.","type":"integer","format":"int32"},"error":{"title":"General error description.","type":"string"},"errorDetails":{"title":"List of errors details.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"requestId":{"title":"Request ID used for logging.","type":"string"},"timestamp":{"title":"Error timestamp.","type":"integer","format":"int64"},"quotaLimitExceededDetails":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/QuotaLimitExceededDetails"}}}},"ErrorDetails":{"type":"object","properties":{"message":{"title":"Error message.","type":"string"},"field":{"title":"Error related field.","type":"string"},"rejectedValue":{"title":"Invalid value causing error.","type":"string"}}},"QuotaLimitExceededDetails":{"type":"object","properties":{"quota":{"title":"Quota name.","type":"string"},"message":{"title":"Quota limit message.","type":"string"},"limit":{"title":"Quota limit.","type":"integer","format":"int32"},"entityId":{"title":"Id of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true},"entityType":{"title":"Type of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true}}},"MetadataJobResponse":{"title":"Result list","type":"object","properties":{"id":{"title":"JobId","type":"string"},"totalProducts":{"title":"totalProducts","type":"integer","format":"int32"},"executedProducts":{"title":"executedProducts","type":"integer","format":"int32"},"totalCategories":{"title":"totalCategories","type":"integer","format":"int32"},"executedCategories":{"title":"executedCategories","type":"integer","format":"int32"},"status":{"title":"status","type":"string"},"createdBy":{"title":"createdBy","type":"string"},"createdAt":{"title":"createdAt","type":"string","format":"date-time"},"modifiedBy":{"title":"modifiedBy","type":"string"},"modifiedAt":{"title":"modifiedAt","type":"string","format":"date-time"}}},"PushAllMetadataRequest":{"required":["force"],"type":"object","properties":{"force":{"title":"Force","type":"boolean","description":"Force created a new job and Cancel the running job","default":false}}},"SearchMetadataJobResponse":{"type":"object","properties":{"total":{"title":"Total of result.","type":"integer","format":"int64"},"page":{"title":"page","type":"integer","format":"int32"},"pageSize":{"title":"page size","type":"integer","format":"int32"},"data":{"title":"Result list","type":"array","items":{"$ref":"#/components/schemas/MetadataJobResponse"}}}},"ListSeoResponse":{"type":"object","properties":{"sefurls":{"title":"SEF URL response data.","type":"array","items":{"$ref":"#/components/schemas/SeoResponse"}},"total":{"title":"Total of response.","type":"integer","format":"int64"},"metaInformation":{"$ref":"#/components/schemas/MetaInformation"},"openGraphInformation":{"$ref":"#/components/schemas/OpenGraphInformation"}}},"MetaInformation":{"title":"Meta information.","type":"object","properties":{"metaTitle":{"title":"Meta title.","type":"string"},"metaDescription":{"title":"Meta description.","type":"string"},"metaKeyWords":{"title":"Meta keywords list.","type":"array","items":{"title":"Meta keywords list.","type":"string"}},"metaNoIndex":{"title":"Boolean of meta index.","type":"boolean"},"metaNoFollow":{"title":"Boolean of meta no follow.","type":"boolean"}}},"OpenGraphInformation":{"title":"Open graph information.","type":"object","properties":{"title":{"title":"Open graph title.","type":"string"},"description":{"title":"Open graph description.","type":"string"},"type":{"title":"Open graph type.","type":"string"},"media":{"title":"Open graph media.","type":"string"}}},"SeoResponse":{"title":"Historical.","type":"object","properties":{"id":{"title":"ID.","type":"string"},"url":{"title":"SEF URL.","type":"string"},"type":{"title":"SEF URL type.","type":"string","enum":["CATEGORY","PRODUCT","CMS","SEFURL","CAMPAIGN","CONTENT"]},"structure":{"title":"Category structures list.","type":"array","items":{"$ref":"#/components/schemas/Structure"}},"organizationId":{"title":"Organization ID.","type":"string"},"status":{"title":"SEF URL status (active, historical).","type":"string","enum":["ACTIVE","HISTORICAL","ARCHIVE"]},"canonicalId":{"title":"Canonical ID of SEF URL.","type":"string"},"modifiedAt":{"title":"Modified time.","type":"string"},"modifiedBy":{"title":"Modified user.","type":"string"},"sefId":{"title":"SEF ID.","type":"string"},"default":{"title":"This SEF URL is default?.","type":"boolean"},"updated":{"title":"This SEF URL is updated?.","type":"boolean"}}},"Structure":{"title":"Category structures list.","type":"object","properties":{"name":{"title":"Category name.","type":"string"},"id":{"title":"Category ID.","type":"string"}}},"SEFUrlResponse":{"title":"SEF URL response data.","type":"object","properties":{"id":{"title":"ID.","type":"string"},"url":{"title":"SEF URL.","type":"string"},"type":{"title":"SEF URL type.","type":"string","enum":["CATEGORY","PRODUCT","CMS","SEFURL","CAMPAIGN","CONTENT"]},"metaInformation":{"$ref":"#/components/schemas/MetaInformation"},"openGraphInformation":{"$ref":"#/components/schemas/OpenGraphInformation"},"structure":{"title":"Category structures list.","type":"array","items":{"$ref":"#/components/schemas/Structure"}},"organizationId":{"title":"Organization ID.","type":"string"},"status":{"title":"SEF URL status (active, historical).","type":"string","enum":["ACTIVE","HISTORICAL","ARCHIVE"]},"canonicalId":{"title":"Canonical ID of SEF URL.","type":"string"},"modifiedAt":{"title":"Modified time.","type":"string"},"modifiedBy":{"title":"Modified user.","type":"string"},"sefId":{"title":"SEF ID.","type":"string"},"default":{"title":"This SEF URL is default?.","type":"boolean"},"updated":{"title":"This SEF URL is updated?.","type":"boolean"}}},"MetaInformationRequest":{"type":"object","properties":{"title":{"title":"Meta title.","type":"string"},"description":{"title":"Meta description.","type":"string"},"keywords":{"title":"Meta keywords list.","type":"array","items":{"title":"Meta keywords list.","type":"string"}},"noIndex":{"title":"Meta no index.","type":"boolean"},"noFollow":{"title":"Meta no follow.","type":"boolean"}}},"OpenGraphInformationRequest":{"type":"object","properties":{"title":{"title":"Open graph title.","type":"string"},"description":{"title":"Open graph description.","type":"string"},"type":{"title":"Open graph type.","type":"string"},"media":{"title":"Open graph media.","type":"string"}}},"FieldSettingRequest":{"required":["field","fieldType"],"type":"object","properties":{"fieldType":{"title":"Type data from(Info or attribute).","type":"string","default":"INFO","enum":["ATTRIBUTE","INFO"]},"field":{"title":"Field to use for generate SEF.","type":"string"}}},"SettingRequest":{"required":["conversionOption","ignoreCatalog"],"type":"object","properties":{"product":{"$ref":"#/components/schemas/FieldSettingRequest"},"category":{"$ref":"#/components/schemas/FieldSettingRequest"},"cms":{"$ref":"#/components/schemas/FieldSettingRequest"},"campaign":{"$ref":"#/components/schemas/FieldSettingRequest"},"ignoreCatalog":{"title":"Boolean for ignore catalog (main category).","type":"boolean","default":true},"conversionOption":{"title":"URL conversion optional.","type":"string","default":"INTERNATIONAL","enum":["INTERNATIONAL","CONVERTING"]}}},"SettingResponse":{"required":["conversionOption","ignoreCatalog"],"type":"object","properties":{"product":{"$ref":"#/components/schemas/FieldSettingRequest"},"category":{"$ref":"#/components/schemas/FieldSettingRequest"},"cms":{"$ref":"#/components/schemas/FieldSettingRequest"},"campaign":{"$ref":"#/components/schemas/FieldSettingRequest"},"ignoreCatalog":{"title":"Boolean for ignore catalog (main category).","type":"boolean","default":true},"conversionOption":{"title":"URL conversion optional.","type":"string","default":"INTERNATIONAL","enum":["INTERNATIONAL","CONVERTING"]},"id":{"title":"Setting ID.","type":"string"},"modifiedAt":{"title":"Modified Date time.","type":"string"},"modifiedBy":{"title":"Modified User.","type":"string"}}},"NormalResponse":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}},"GenerateSEFUrlJob":{"type":"object","properties":{"id":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"jobStatus":{"type":"string","enum":["IN_PROGRESS","FAILED","DONE"]},"errorMessage":{"type":"string"},"organizationId":{"type":"string"},"categoryId":{"type":"string"},"totalUpdated":{"type":"integer","format":"int32"},"totalAdded":{"type":"integer","format":"int32"},"totalRemoved":{"type":"integer","format":"int32"},"context":{"type":"string"},"error":{"type":"string"},"includedCMS":{"type":"boolean"},"includedCampaign":{"type":"boolean"}}},"GenerateSEFListRequest":{"type":"object","properties":{"includeProduct":{"title":"Include product/category","type":"boolean"},"categoryId":{"title":"Category ID.","type":"string"},"includeCMS":{"title":"Include CMS.","type":"boolean"},"includeCampaign":{"title":"Include campaign","type":"boolean"}}},"ListGenerateSEFUrlJobResponse":{"type":"object","properties":{"data":{"title":"Generate SEF URLs job data.","type":"array","items":{"$ref":"#/components/schemas/GenerateSEFUrlJob"}},"total":{"title":"Total of job.","type":"integer","format":"int64"}}},"UpdateGenerateSEFUrlsJobRequest":{"required":["status"],"type":"object","properties":{"status":{"title":"Status job","type":"string","enum":["IN_PROGRESS","FAILED","DONE"]}}},"HistoryRequest":{"type":"object","properties":{"url":{"title":"SEF URL.","type":"string"},"structure":{"title":"Category structures.","type":"array","items":{"$ref":"#/components/schemas/Structure"}}},"description":"History Request"},"SefUrlWithMetaResponse":{"type":"object","properties":{"id":{"title":"ID.","type":"string"},"url":{"title":"SEF URL.","type":"string"},"type":{"title":"SEF URL type.","type":"string","enum":["CATEGORY","PRODUCT","CMS","SEFURL","CAMPAIGN","CONTENT"]},"structure":{"title":"Category structures list.","type":"array","items":{"$ref":"#/components/schemas/Structure"}},"organizationId":{"title":"Organization ID.","type":"string"},"status":{"title":"SEF URL status (active, historical).","type":"string","enum":["ACTIVE","HISTORICAL","ARCHIVE"]},"canonicalId":{"title":"Canonical ID of SEF URL.","type":"string"},"modifiedAt":{"title":"Modified time.","type":"string"},"modifiedBy":{"title":"Modified user.","type":"string"},"sefId":{"title":"SEF ID.","type":"string"},"historical":{"title":"Historical.","type":"array","items":{"$ref":"#/components/schemas/SeoResponse"}},"metaInformation":{"$ref":"#/components/schemas/MetaInformation"},"openGraphInformation":{"$ref":"#/components/schemas/OpenGraphInformation"},"default":{"type":"boolean"},"updated":{"type":"boolean"}}},"ListSEFUrlResponse":{"type":"object","properties":{"data":{"title":"SEF URL response data.","type":"array","items":{"$ref":"#/components/schemas/SEFUrlResponse"}},"total":{"title":"Total of response.","type":"integer","format":"int64"}}},"PostListSefUrlRequest":{"type":"object","properties":{"data":{"type":"array","description":"data","items":{"type":"string","description":"data"}}}},"UpdateSefUrlRequest":{"required":["url"],"type":"object","properties":{"url":{"title":"New URL.","type":"string"},"default":{"title":"Is default URL.","type":"boolean"}}},"SefUrlValidateResponse":{"type":"object","properties":{"result":{"type":"boolean"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}