{"openapi":"3.0.1","info":{"title":"Product PDF","description":"Bluestone PDF 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/pdf"}],"tags":[{"name":"Technical","description":"To get technical information."},{"name":"Configurations","description":"To handle pdf variable configuration."},{"name":"PDF Jobs","description":"PDF job operations and monitoring."},{"name":"PDF services","description":"To print and preview pdf content."},{"name":"Settings","description":"To manage field / value."},{"name":"Template analyzes","description":"To analyze template usage."},{"name":"Templates","description":"To manage template."},{"name":"Template versions","description":"To manage template version."}],"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":[]}]}},"/configs":{"get":{"tags":["Configurations"],"summary":"To list configs.","operationId":"getConfig","responses":{"200":{"description":"Config is listed","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SettingResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Configurations"],"summary":"To create config.","operationId":"createConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSettingRequest"}}}},"responses":{"200":{"description":"Config is created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/configs/{id}":{"put":{"tags":["Configurations"],"summary":"To update config.","operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSettingRequest"}}}},"responses":{"200":{"description":"Config updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Config not found"},"500":{"description":"Cannot update config"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Configurations"],"summary":"To delete config.","operationId":"deleteConfig","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Config deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Config not found"},"500":{"description":"Cannot delete config"}},"security":[{"oauth2":[]}]}},"/configs/by-name":{"get":{"tags":["Configurations"],"summary":"To get config by name.","operationId":"getConfigByConfigName","parameters":[{"name":"name","in":"query","description":"Name of config","schema":{"type":"string"}}],"responses":{"200":{"description":"Config is returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"}},"security":[{"oauth2":[]}]}},"/pdf-jobs/{id}":{"get":{"tags":["PDF Jobs"],"summary":"To get async PDF job status.","operationId":"getPdfJob","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF job found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"PDF job not found"},"429":{"description":"Too many status poll requests - retry after the given delay"}},"security":[{"oauth2":[]}]}},"/pdf-jobs/sweep-stuck":{"post":{"tags":["PDF Jobs"],"summary":"Manually trigger sweep for stuck PDF jobs.","operationId":"sweepStuckPdfJobs","responses":{"200":{"description":"Sweeper executed"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot execute sweeper"}},"security":[{"oauth2":[]}]}},"/pdfs/delete-all":{"delete":{"tags":["PDF services"],"summary":"To delete all PDF jobs.","operationId":"deleteAll","responses":{"204":{"description":"Delete success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"PDF job not found"},"500":{"description":"Delete error"}},"security":[{"oauth2":[]}]}},"/pdfs":{"get":{"tags":["PDF services"],"summary":"To list PDF job.","operationId":"getJobList","parameters":[{"name":"searchTerm","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"PDF are listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPdfResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["PDF services"],"summary":"To delete PDF for given job.","operationId":"deleteMultiple","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipleDeleteJobRequest"}}}},"responses":{"204":{"description":"Delete success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"PDF job not found"},"500":{"description":"Delete error"}},"security":[{"oauth2":[]}]}},"/pdfs/multi/status/{id}":{"get":{"tags":["PDF services"],"summary":"To print PDF by filter id.","operationId":"getMulti","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get multi PDF status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPrintResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"}},"security":[{"oauth2":[]}]}},"/pdfs/{id}":{"get":{"tags":["PDF services"],"summary":"To get PDF.","operationId":"getPdf","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"PDF job not found"}},"security":[{"oauth2":[]}]}},"/pdfs/invalidate-all-cache":{"post":{"tags":["PDF services"],"summary":"To invalidate all cache","operationId":"invalidateAllCache","responses":{"204":{"description":"Invalidate success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Error"}},"security":[{"oauth2":[]}]}},"/pdfs/invalidate-cache":{"post":{"tags":["PDF services"],"summary":"To invalidate cache in Organization with specific context","operationId":"invalidateCache","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"responses":{"204":{"description":"Invalidate success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Error"}},"security":[{"oauth2":[]}]}},"/pdfs/preview":{"post":{"tags":["PDF services"],"summary":"To preview PDF by template ID.","operationId":"preview","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"description":"PDF preview request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfJobRequest"}}}},"responses":{"200":{"description":"Preview displayed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfPreviewResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unable to preview"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/preview/html":{"post":{"tags":["PDF services"],"summary":"To preview PDF by html.","operationId":"previewHtml","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePreviewRequest"}}}},"responses":{"200":{"description":"Preview by html displayed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfPreviewResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Inter server error"}},"security":[{"oauth2":[]}]}},"/pdfs/print/html":{"post":{"tags":["PDF services"],"summary":"To print PDF by html.","operationId":"printHtml","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}},{"name":"skipFetchData","in":"query","description":"Skip fetch product data if want to print by using only HTML content.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePreviewRequest"}}}},"responses":{"200":{"description":"Pdf file returned","content":{"application/octet-stream":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/print/html/async":{"post":{"tags":["PDF services"],"summary":"To asynchronously print PDF by html. Registers a job and returns immediately.","operationId":"printHtmlAsync","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncPrintHtmlRequest"}}}},"responses":{"202":{"description":"Job registered","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncPrintHtmlResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/print/html/download-url":{"post":{"tags":["PDF services"],"summary":"To print PDF by html and generate download URL.","operationId":"printHtmlPresignedUrl","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}},{"name":"skipFetchData","in":"query","description":"Skip fetch product data if want to print by using only HTML content.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePreviewRequest"}}}},"responses":{"200":{"description":"URL to preview the generated PDF.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfPreviewUrlInfo"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/criteria/print":{"post":{"tags":["PDF services"],"summary":"To print PDF by filter criteria.","operationId":"printMultiByFilterCriteria","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterCriteriaPrintRequest"}}}},"responses":{"200":{"description":"PDF printed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/query/print":{"post":{"tags":["PDF services"],"summary":"To print PDF by query builder.","operationId":"printMultiByQuery","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPrintRequest"}}}},"responses":{"200":{"description":"PDF printed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/products/list/print":{"post":{"tags":["PDF services"],"summary":"To print PDF by list of product ids.","operationId":"printProductByIdList","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListPrintRequest"}}}},"responses":{"200":{"description":"PDF printed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/pdfs/single/print":{"post":{"tags":["PDF services"],"summary":"To print PDF by a reference id.","operationId":"printSingle","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"description":"PDF print single product request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfJobRequest"}}}},"responses":{"200":{"description":"PDF printed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/fields":{"get":{"tags":["Settings"],"summary":"To get field list.","operationId":"getFieldList","responses":{"200":{"description":"Get field list successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get list"}},"security":[{"oauth2":[]}]},"post":{"tags":["Settings"],"summary":"To create field.","operationId":"createField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldRequest"}}}},"responses":{"200":{"description":"Created Field"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot create Field"}},"security":[{"oauth2":[]}]}},"/settings/values/fields/{id}":{"get":{"tags":["Settings"],"summary":"To get value by field id.","operationId":"getValue","parameters":[{"name":"id","in":"path","description":"Field Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get value successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Value not found"},"500":{"description":"Cannot get value or field not found"}},"security":[{"oauth2":[]}]},"post":{"tags":["Settings"],"summary":"To create value.","operationId":"createValue","parameters":[{"name":"id","in":"path","description":"Field Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueRequest"}}}},"responses":{"201":{"description":"Created value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot create value"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Settings"],"summary":"To delete value by field id.","operationId":"deleteValue","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Value not found"},"500":{"description":"Cannot delete value or field not found"}},"security":[{"oauth2":[]}]},"patch":{"tags":["Settings"],"summary":"To update value by field id.","operationId":"updateValue","parameters":[{"name":"id","in":"path","description":"Field Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueRequest"}}}},"responses":{"200":{"description":"Template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValueResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Value not found"},"500":{"description":"Cannot update value"}},"security":[{"oauth2":[]}]}},"/settings/fields/{id}":{"get":{"tags":["Settings"],"summary":"To get field by id.","operationId":"getField","parameters":[{"name":"id","in":"path","description":"Field id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Field not found"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Settings"],"summary":"To delete field.","operationId":"deleteField","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Field not found"}},"security":[{"oauth2":[]}]},"patch":{"tags":["Settings"],"summary":"To update field.","operationId":"updateField","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldRequest"}}}},"responses":{"200":{"description":"Field updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot update field"}},"security":[{"oauth2":[]}]}},"/settings/fields/structure":{"get":{"tags":["Settings"],"summary":"To get value with field structure.","operationId":"getFieldValueStructure","parameters":[{"name":"includeEmptyValue","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Value structure are list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StructureResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get list"}},"security":[{"oauth2":[]}]}},"/settings/values/map":{"get":{"tags":["Settings"],"summary":"To get provide values.","operationId":"getProvideValue","responses":{"200":{"description":"Get provide value successfully","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get provide value"}},"security":[{"oauth2":[]}]}},"/templates/{id}/analyze":{"get":{"tags":["Template analyzes"],"summary":"To get analyzed data.","operationId":"getAnalyzeTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Analyzed data returned","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateAnalyzeDataResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Analyzed data not found"}},"security":[{"oauth2":[]}]},"post":{"tags":["Template analyzes"],"summary":"To analyze template.","operationId":"analyzeTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"responses":{"200":{"description":"Template analyzed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateAnalyzeResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"}},"security":[{"oauth2":[]}]}},"/templates/{id}/analyze/{analyzeId}":{"put":{"tags":["Template analyzes"],"summary":"To update analyzed data.","operationId":"updateAnalyzeTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"analyzeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateAnalyzeRequest"}}}},"responses":{"200":{"description":"Analyzed data returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateAnalyzeDataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Analyzed data not found"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Template analyzes"],"summary":"To delete analyzed data.","operationId":"deleteAnalyzeTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"analyzeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Data not found"},"500":{"description":"Cannot delete data"}},"security":[{"oauth2":[]}]}},"/templates/{id}/triggers":{"get":{"tags":["Template analyzes"],"summary":"To get analyzed data and get addition info from PIM.","operationId":"triggers","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Analyzed data returned","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateTriggerResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Analyzed data not found"}},"security":[{"oauth2":[]}]}},"/templates/pattern":{"patch":{"tags":["Template analyzes"],"summary":"To update template's pattern for analyze.","operationId":"updateTemplatePattern","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TemplateRegexConfiguration"}}}}},"responses":{"200":{"description":"Pattern updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePatternResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot update pattern"}},"security":[{"oauth2":[]}]}},"/templates/{id}/copy":{"post":{"tags":["Templates"],"summary":"To copy template.","operationId":"copyTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyTemplateRequest"}}}},"responses":{"200":{"description":"Template copied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"},"500":{"description":"Cannot copy template"}},"security":[{"oauth2":[]}]}},"/templates":{"post":{"tags":["Templates"],"summary":"To create template.","operationId":"createTemplate","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateRequest"}}}},"responses":{"201":{"description":"Template created","headers":{"Location":{"description":" Location URI (Uniform Resource Identifier). This field is the URI of the newly created resource.\n","schema":{"type":"string"}},"Resource-Id":{"description":"  Entity ID. The unique ID of the newly created resource.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot add template"}},"security":[{"oauth2":[]}]}},"/templates/{id}":{"get":{"tags":["Templates"],"summary":"To get template by id.","operationId":"getTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}},{"name":"labelType","in":"query","schema":{"type":"string","default":"name","enum":["id","name"]}}],"responses":{"200":{"description":"Template described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"},"500":{"description":"Cannot describe template"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Templates"],"summary":"To delete template.","operationId":"deleteTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"},"500":{"description":"Cannot delete template"}},"security":[{"oauth2":[]}]},"patch":{"tags":["Templates"],"summary":"To update template.","operationId":"updateTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemplateRequest"}}}},"responses":{"200":{"description":"Template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"},"500":{"description":"Cannot update template"}},"security":[{"oauth2":[]}]}},"/templates/{id}/download":{"get":{"tags":["Templates"],"summary":"To download template.","operationId":"download","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"responses":{"200":{"description":"File is downloaded"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"File not found"}},"security":[{"oauth2":[]}]}},"/templates/list":{"get":{"tags":["Templates"],"summary":"To list templates by query.","operationId":"getTemplateListByQuery","parameters":[{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}},{"name":"fileName","in":"query","description":"If contain fileName in template","schema":{"type":"boolean"}},{"name":"group","in":"query","description":"Group name.","schema":{"type":"string"}},{"name":"labelType","in":"query","description":"Label type, default value is name.","schema":{"type":"string","default":"name","enum":["id","name"]}},{"name":"query","in":"query","description":"Search name or code.","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Listed template successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplateResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"}},"security":[{"oauth2":[]}]}},"/templates/{id}/upload":{"post":{"tags":["Templates"],"summary":"To upload template.","operationId":"uploadTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"},"500":{"description":"Cannot update template"}},"security":[{"oauth2":[]}]}},"/templates/{id}/versions/{versionId}":{"put":{"tags":["Template versions"],"summary":"To restore template version.","operationId":"restoreTemplate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}}],"responses":{"200":{"description":"Template version restored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateVersionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template or template version not found"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Template versions"],"summary":"To delete template version.","operationId":"deleteTemplate_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template version deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template version not found"}},"security":[{"oauth2":[]}]}},"/templates/{id}/versions":{"get":{"tags":["Template versions"],"summary":"To get template version.","operationId":"getTemplate_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","description":"Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.","schema":{"type":"string","default":"en"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Template version described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplateVersionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Template not found"}},"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}}},"SettingResponse":{"type":"object","properties":{"id":{"title":"Configuration Id.","type":"string"},"name":{"title":"Configuration title.","type":"string"},"description":{"title":"Configuration description.","type":"string"},"values":{"title":"Configuration filter values.","type":"array","items":{"title":"Configuration filter values.","type":"string"}},"createdAt":{"title":"Configuration created timestamp.","type":"string"},"createdBy":{"title":"Configuration created user.","type":"string"}}},"CreateSettingRequest":{"required":["name","values"],"type":"object","properties":{"name":{"title":"Config name.","type":"string","example":"mediabank-prefetch"},"description":{"title":"Config description.","type":"string"},"values":{"title":"Config list.","type":"array","example":["contains;_icon_"],"items":{"title":"Config list.","type":"string","example":"[\"contains;_icon_\"]"}}}},"UpdateSettingRequest":{"required":["name"],"type":"object","properties":{"name":{"title":"Config name.","type":"string","example":"mediabank-prefetch"},"description":{"title":"Config description.","type":"string"},"values":{"title":"Config list.","type":"array","example":["contains;_icon_"],"items":{"title":"Config list.","type":"string","example":"[\"contains;_icon_\"]"}}}},"PdfResponse":{"type":"object","properties":{"id":{"title":"PDF Print Id.","type":"string"},"createdAt":{"title":"Created PDF time.","type":"string"},"createdBy":{"title":"Created PDF user.","type":"string"},"modifiedAt":{"title":"Modified PDF time.","type":"string"},"modifiedBy":{"title":"Modified PDF user.","type":"string"},"jobId":{"title":"Generated PDF job id.","type":"string"},"jobTitle":{"title":"Generated PDF job title.","type":"string"},"templateId":{"title":"PDF Template id.","type":"string"},"jobStatus":{"title":"Job Status.","type":"string"},"refId":{"title":"Entity or Product Id.","type":"string"},"templateName":{"title":"PDF Template name.","type":"string"},"context":{"title":"Generated PDF Context id.","type":"string"},"contextName":{"title":"Generated PDF Context locale.","type":"string"},"downloadUrl":{"title":"Presigned download URL for the generated PDF. Present only when jobStatus is DONE.","type":"string"},"expiresAt":{"title":"Expiration time of the presigned download URL.","type":"string"},"errorReason":{"title":"Reason describing why the job did not complete successfully. Present only for failure states.","type":"string"}}},"MultipleDeleteJobRequest":{"type":"object","properties":{"jobIds":{"type":"array","items":{"title":"List of Job Id.","type":"string"}},"refIds":{"type":"array","items":{"title":"List of Entity Id or Product Id.","type":"string"}},"templateId":{"title":"Template id.","type":"string","example":"templateId"},"jobStatus":{"title":"Job status to remove.","type":"string","example":"IN_PROGRESS","enum":["INIT","IN_PROGRESS","FAILED","DONE","FAILED_AFTER_RETRY","CREATED_HTML","CREATED_PDF","PRODUCT_ARCHIVED"]}}},"ListPdfResponse":{"type":"object","properties":{"total":{"title":"Total number of items.","type":"integer","format":"int64"},"data":{"title":"List of items.","type":"array","items":{"$ref":"#/components/schemas/PdfResponse"}}}},"MultiPrintResponse":{"type":"object","properties":{"id":{"title":"Multiprint Id.","type":"string"},"filterId":{"title":"Filter Id from PIM.","type":"string"},"createdAt":{"title":"Multiprint timestamp.","type":"string"},"status":{"title":"Multiprint status.","type":"string"},"templateName":{"title":"Template name for print.","type":"string"},"filterName":{"title":"Filter name from PIM.","type":"string"},"contextId":{"title":"PDF generate context id.","type":"string"},"contextName":{"title":"PDF generate context locale.","type":"string"},"percentDone":{"title":"Percentage done of overall print.","type":"integer","format":"int32"}}},"PdfPreviewResponse":{"type":"object","properties":{"html":{"title":"Generated html content from template.","type":"string"},"refId":{"title":"Entity or Product Id.","type":"string"}}},"PdfJobRequest":{"required":["refId","templateId"],"type":"object","properties":{"templateId":{"title":"Template Id.","type":"string"},"refId":{"title":"Entity Id or Product Id.","type":"string"},"source":{"title":"Entity source.","type":"string","example":"pim"},"options":{"title":"File Name or Asset Name Options.","type":"object","additionalProperties":{"title":"File Name or Asset Name Options.","type":"string","example":"{\"filename\":\"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]\"}"},"example":{"filename":"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]"}}}},"TemplatePreviewRequest":{"required":["refId","templateId"],"type":"object","properties":{"templateId":{"title":"Template id.","type":"string","example":"templateId"},"refId":{"title":"Entity Id.","type":"string","example":"productId"},"html":{"title":"Generated HTML content to print PDF.","type":"string"},"format":{"title":"Template format","pattern":"^$|^(Letter|Legal|Tabloid|Ledger|A0|A1|A2|A3|A4|A5|A6)$","type":"string","example":"A4"},"width":{"title":"Template width","pattern":"^$|^\\d+(\\.\\d+)?$","type":"string","example":"800"},"height":{"title":"Template height","pattern":"^$|^\\d+(\\.\\d+)?$","type":"string","example":"600"},"unit":{"title":"Unit","pattern":"^$|^(mm|cm|in|px)$","type":"string","example":"mm"}}},"AsyncPrintHtmlResponse":{"type":"object","properties":{"jobId":{"title":"Job id.","type":"string"}}},"AsyncPrintHtmlRequest":{"required":["html"],"type":"object","properties":{"html":{"title":"Generated HTML content to print PDF.","type":"string"},"refId":{"title":"Caller correlation id -- must be a valid ObjectId when supplied. Optional; the jobId is used when absent.","type":"string","example":"507f1f77bcf86cd799439011"},"jobTitle":{"title":"Optional human-readable job title.","type":"string"},"format":{"title":"Template format","pattern":"^$|^(Letter|Legal|Tabloid|Ledger|A0|A1|A2|A3|A4|A5|A6)$","type":"string","example":"A4"},"width":{"title":"Template width","pattern":"^$|^\\d+(\\.\\d+)?$","type":"string","example":"800"},"height":{"title":"Template height","pattern":"^$|^\\d+(\\.\\d+)?$","type":"string","example":"600"},"unit":{"title":"Unit","pattern":"^$|^(mm|cm|in|px)$","type":"string","example":"mm"}}},"PdfPreviewUrlInfo":{"type":"object","properties":{"pdfUrl":{"title":"Generated PDF preview URL.","type":"string","example":"https://example.com/preview.pdf"},"method":{"title":"HTTP method for URL.","type":"string","example":"GET"},"expiresAt":{"title":"URL expiration time.","type":"string","example":"2024-12-31T23:59:59Z"},"createdAt":{"title":"URL creation time.","type":"string","example":"2024-12-01T12:00:00Z"}}},"JobResponse":{"type":"object","properties":{"id":{"title":"Job id.","type":"string"},"printType":{"title":"Print type.","type":"string"},"jobStatus":{"title":"Job status.","type":"string"},"pdfPrintParams":{"$ref":"#/components/schemas/PdfJobRequest"},"multiPrintParams":{"$ref":"#/components/schemas/MultiPrintPdfRequest"},"productListPrintParams":{"$ref":"#/components/schemas/ProductListPrintRequest"},"contextId":{"title":"Context Id.","type":"string"},"userId":{"title":"User Id.","type":"string"},"numberOfRetry":{"title":"Number of retry processing job.","type":"integer","format":"int32"},"createdAt":{"title":"Job created time.","type":"string"},"createdBy":{"title":"Job created user.","type":"string"},"organizationId":{"title":"Organization Id.","type":"string"},"multiPrintId":{"title":"Multi print Id.","type":"string"},"externalId":{"title":"External Id.","type":"string"}}},"ListJobResponse":{"type":"object","properties":{"total":{"title":"Total number of items.","type":"integer","format":"int64"},"data":{"title":"List of items.","type":"array","items":{"$ref":"#/components/schemas/JobResponse"}}}},"MultiPrintPdfRequest":{"title":"Multi print params.","required":["filterId","multiPrintId","templateId"],"type":"object","properties":{"filterId":{"title":"Filter id.","type":"string"},"templateId":{"title":"Template id.","type":"string"},"multiPrintId":{"title":"Multi print id.","type":"string"}}},"ProductListPrintRequest":{"title":"Product Id list print params.","required":["productIdList","templateId"],"type":"object","properties":{"productIdList":{"title":"Product ID list to print.","type":"array","items":{"title":"Product ID list to print.","type":"string"}},"templateId":{"title":"Template id.","type":"string","example":"templateId"}}},"AssetFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HAVE_NONE","HAVE_ANY","HAVE_MORE_THAN","HAVE_LESS_THAN","ASSIGNED_TO_ANY","ASSIGNED_TO_ALL","NOT_HAVE_LABEL","HAVE_LABEL"]},"labelsIds":{"type":"array","items":{"type":"string"}},"assetCount":{"type":"integer","format":"int32"},"assetIds":{"type":"array","items":{"type":"string"}}}},"AttributeFilter":{"required":["attributeDefinitionId","type"],"type":"object","properties":{"type":{"type":"string","enum":["CONTAINS","NOT_CONTAINS","EQUALS","NOT_EQUALS","EMPTY","NOT_EMPTY","BETWEEN","NOT_BETWEEN","GREATER_THAN","GREATER_OR_EQUALS_TO","SMALLER_THAN","SMALLER_OR_EQUALS_TO","DOES_HAVE_SOME","DOESNT_HAVE_ANY","DOES_HAVE_ALL","DOESNT_HAVE_ALL","ASSOCIATED","NOT_ASSOCIATED","IN","DATE_RELATIVE"]},"attributeDefinitionId":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"unit":{"type":"string","enum":["DAYS_AGO","DAYS_FROM_NOW"]}}},"BaseFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NAME_IS","NAME_CONTAINS","NAME_NOT_CONTAINS","NAME_STARTS_WITH","NAME_ENDS_WITH","NAME_EMPTY","NAME_NOT_EMPTY","NUMBER_IS","NUMBER_CONTAINS","NUMBER_NOT_CONTAINS","NUMBER_STARTS_WITH","NUMBER_ENDS_WITH","NUMBER_IN","DESCRIPTION_IS","DESCRIPTION_CONTAINS","DESCRIPTION_NOT_CONTAINS","DESCRIPTION_STARTS_WITH","DESCRIPTION_ENDS_WITH","DESCRIPTION_EMPTY","DESCRIPTION_NOT_EMPTY","ID_IN","NUMBER_NOT_IN","LAST_MODIFIED_BY_IS","LAST_MODIFIED_BY_CURRENT_USER"]},"values":{"type":"array","items":{"type":"string"}}}},"BundleFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HAVE_NONE","HAVE_ANY","HAVE_MORE_THAN","HAVE_LESS_THAN"]},"bundleCount":{"type":"integer","format":"int32"}}},"CategoryFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["IN_ANY_CHILD","IN_CATEGORY","WITHOUT_CATEGORY"]},"categoryId":{"type":"string"}}},"CreateDateFilter":{"required":["dateMilis","type"],"type":"object","properties":{"type":{"type":"string","enum":["GREATER_EQUAL","LESS_EQUAL"]},"dateMilis":{"type":"integer","format":"int64"}}},"CreateDateRelativeFilter":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["DAYS_AGO"]},"value":{"type":"integer","format":"int64"}}},"FilterCriteriaPrintRequest":{"required":["criteria","templateId"],"type":"object","properties":{"templateId":{"title":"Template id.","type":"string","example":"templateId"},"criteria":{"$ref":"#/components/schemas/PimProductSearchRequest"}}},"GroupFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HAVE_NONE","HAVE_ANY","HAVE_MORE_THAN","HAVE_LESS_THAN"]},"groupCount":{"type":"integer","format":"int32"}}},"LabelFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["ALL","SOME","NOT","EMPTY"]},"labelsIds":{"type":"array","items":{"type":"string"}}}},"LastSyncStateFilter":{"required":["lastSyncState","type"],"type":"object","properties":{"type":{"type":"string","enum":["IS"]},"lastSyncState":{"type":"string","enum":["SUCCESSFUL","FAILED"]}}},"LastUpdateFilter":{"required":["dateMilis","type"],"type":"object","properties":{"type":{"type":"string","enum":["GREATER_EQUAL","LESS_EQUAL"]},"dateMilis":{"type":"integer","format":"int64"}}},"LastUpdateRelativeFilter":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["DAYS_AGO"]},"value":{"type":"integer","format":"int64"}}},"OutOfSyncFilter":{"required":["outOfSync","type"],"type":"object","properties":{"type":{"type":"string","enum":["IS"]},"outOfSync":{"type":"boolean"}}},"PimProductSearchRequest":{"title":"Product filter request from core search.","required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"column":{"type":"string","enum":["PRODUCT_NAME","PRODUCT_NUMBER","PRODUCT_TYPE","ATTRIBUTE","LAST_UPDATE","CREATE_DATE"]},"sortDirection":{"type":"string","enum":["ASC","DESC"]},"attributeIdToSortBy":{"type":"string"},"typeFilter":{"$ref":"#/components/schemas/TypeFilter"},"typesFilter":{"$ref":"#/components/schemas/TypesFilter"},"productCreateDateFilter":{"type":"array","items":{"$ref":"#/components/schemas/CreateDateFilter"}},"productCreateDateRelativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/CreateDateRelativeFilter"}},"productLastUpdateFilter":{"type":"array","items":{"$ref":"#/components/schemas/LastUpdateFilter"}},"productLastUpdateRelativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/LastUpdateRelativeFilter"}},"baseFilters":{"type":"array","items":{"$ref":"#/components/schemas/BaseFilter"}},"publishStateFilter":{"$ref":"#/components/schemas/PublishStateFilter"},"validationStatusFilter":{"$ref":"#/components/schemas/ValidationStatusFilter"},"attributeFilters":{"type":"array","items":{"$ref":"#/components/schemas/AttributeFilter"}},"labelFilters":{"type":"array","items":{"$ref":"#/components/schemas/LabelFilter"}},"relationsFilter":{"$ref":"#/components/schemas/RelationsFilter"},"assetFilters":{"type":"array","items":{"$ref":"#/components/schemas/AssetFilter"}},"variantFilters":{"type":"array","items":{"$ref":"#/components/schemas/VariantFilter"}},"bundleFilters":{"type":"array","items":{"$ref":"#/components/schemas/BundleFilter"}},"categoryFilters":{"type":"array","items":{"$ref":"#/components/schemas/CategoryFilter"}},"scoreFilter":{"$ref":"#/components/schemas/ScoreFilter"},"scoreRequirementResultFilters":{"type":"array","items":{"$ref":"#/components/schemas/ScoreRequirementResultFilter"}},"outOfSyncFilter":{"$ref":"#/components/schemas/OutOfSyncFilter"},"lastSyncStateFilter":{"$ref":"#/components/schemas/LastSyncStateFilter"},"groupFilters":{"type":"array","items":{"$ref":"#/components/schemas/GroupFilter"}}}},"PublishStateFilter":{"required":["publishStates","type"],"type":"object","properties":{"type":{"type":"string","enum":["IN"]},"publishStates":{"type":"array","items":{"type":"string","enum":["PLAYGROUND_ONLY","TO_BE_PUBLISHED","CONNECTED","TO_BE_UNPUBLISHED","NOT_CONNECTED","TO_BE_ARCHIVED","ARCHIVED"]}}}},"RelationsFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["EMPTY","HAVE","NOT"]},"relationId":{"type":"string"},"productIds":{"type":"array","items":{"type":"string"}},"reverse":{"type":"boolean"}}},"ScoreFilter":{"required":["scores","type"],"type":"object","properties":{"type":{"type":"string","enum":["BETWEEN"]},"scores":{"type":"array","items":{"type":"number"}}}},"ScoreRequirementResultFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NOT_MEET_ALL"]},"requirementIds":{"type":"array","items":{"type":"string"}}}},"TypeFilter":{"required":["type"],"type":"object","properties":{"groupIds":{"type":"array","items":{"type":"string"}},"familyIds":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["BUNDLE","GROUP","VARIANT","SINGLE","FAMILY"]}}},"TypesFilter":{"required":["productTypes","type"],"type":"object","properties":{"productTypes":{"type":"array","items":{"type":"string","enum":["BUNDLE","GROUP","VARIANT","SINGLE","FAMILY"]}},"type":{"type":"string","enum":["IN"]}}},"ValidationStatusFilter":{"required":["type","validationStatus"],"type":"object","properties":{"type":{"type":"string","enum":["IN"]},"validationStatus":{"type":"array","items":{"type":"string","enum":["VALID","INVALID"]}}}},"VariantFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HAVE_NONE","HAVE_ANY","HAVE_MORE_THAN","HAVE_LESS_THAN"]},"variantCount":{"type":"integer","format":"int32"}}},"DataResponse":{"type":"object","properties":{"total":{"title":"Total number of items.","type":"integer","format":"int64"},"data":{"title":"List of items.","type":"array","items":{"type":"object"}}}},"QueryPrintRequest":{"required":["query","templateId"],"type":"object","properties":{"templateId":{"title":"Template id.","type":"string","example":"templateId"},"query":{"title":"Product query request from query builder.","type":"object","additionalProperties":{"title":"Product query request from query builder.","type":"object","example":{}},"example":{}}}},"FieldRequest":{"type":"object","properties":{"priority":{"title":"Priority.","type":"integer","format":"int32","example":0},"title":{"title":"Field title.","type":"string"},"description":{"title":"Field description.","type":"string"},"fieldName":{"title":"Field name.","type":"string"},"type":{"title":"Type.","type":"string","example":"text, image.public or image.private"},"scope":{"title":"Scope.","type":"string","example":"org or user"},"group":{"title":"Field group.","type":"string"}}},"ValueResponse":{"type":"object","properties":{"id":{"title":"Value id.","type":"string"},"priority":{"title":"Priority.","type":"integer","format":"int32","example":0},"fieldId":{"title":"Field id.","type":"string"},"value":{"type":"array","items":{"title":"Field's values.","type":"string"}},"userId":{"title":"User id.","type":"string"},"modifiedAt":{"title":"Latest modified timestamp.","type":"string"},"modifiedBy":{"title":"Latest modified user.","type":"string"},"createdAt":{"title":"Created timestamp.","type":"string"},"createdBy":{"title":"Created user.","type":"string"}}},"ValueRequest":{"type":"object","properties":{"value":{"title":"List of values.","type":"array","items":{"title":"List of values.","type":"string"}}}},"FieldResponse":{"type":"object","properties":{"id":{"title":"Field id.","type":"string"},"priority":{"title":"Priority.","type":"integer","format":"int32","example":0},"title":{"title":"Field title.","type":"string"},"description":{"title":"Field description.","type":"string"},"fieldName":{"title":"Field name.","type":"string"},"type":{"title":"Type.","type":"string","example":"text, image.public or image.private"},"scope":{"title":"Scope.","type":"string","example":"org or user"},"group":{"title":"Field group.","type":"string"},"modifiedAt":{"title":"Latest modified timestamp.","type":"string"},"modifiedBy":{"title":"Latest modified user.","type":"string"},"createdAt":{"title":"Created timestamp.","type":"string"},"createdBy":{"title":"Created user.","type":"string"}}},"StructureResponse":{"type":"object","properties":{"fieldId":{"title":"Field id.","type":"string"},"title":{"title":"Field title.","type":"string"},"type":{"title":"Field type.","type":"string"},"value":{"title":"Value.","type":"string"},"valueId":{"title":"Value id.","type":"string"}}},"TemplateAnalyzeResponse":{"type":"object","properties":{"attributes":{"title":"List of attributes using in the template.","type":"array","items":{"title":"List of attributes using in the template.","type":"string"}},"attributeGroups":{"title":"List of attributes groups in the template.","type":"array","items":{"title":"List of attributes groups in the template.","type":"string"}},"categories":{"title":"List of categories using in the template.","type":"array","items":{"title":"List of categories using in the template.","type":"string"}},"product":{"title":"List of product data using in the template.","type":"array","items":{"title":"List of product data using in the template.","type":"string"}},"variants":{"title":"List of variants data using in the template.","type":"array","items":{"title":"List of variants data using in the template.","type":"string"}},"assets":{"title":"List of product assets data using in the template.","type":"array","items":{"title":"List of product assets data using in the template.","type":"string"}}}},"TemplateAnalyzeDataResponse":{"type":"object","properties":{"analyzeId":{"title":"Analyze id.","type":"string"},"templateId":{"title":"Template id.","type":"string"},"entity":{"title":"Entity type in template.","type":"string","example":"attributeGroup"},"entityId":{"title":"Entity unique value (name/number) in template.","type":"string","example":"attribute_group_number"},"eventType":{"title":"Event type.","type":"string","example":"changed"},"entitySource":{"title":"Event source.","type":"string","example":"product"},"remark":{"title":"Remark.","type":"string"}}},"TemplateTriggerResponse":{"type":"object","properties":{"id":{"title":"Entity reference.","type":"string","description":"This could be number or name that use to refer in template","example":"NUMBER"},"entity":{"title":"Entity type.","type":"string","example":"product"},"source":{"title":"Source of usage.","type":"string","example":"product"},"event_type":{"title":"Rule engine event type.","type":"string","example":"changed"}}},"TemplateAnalyzeRequest":{"type":"object","properties":{"entity":{"title":"Entity type in template.","type":"string","example":"attributeGroup"},"entityId":{"title":"Entity unique value (name/number) in template.","type":"string","example":"attribute_group_number"},"eventType":{"title":"Event type.","type":"string","example":"changed"},"entitySource":{"title":"Event source.","type":"string","example":"product"},"remark":{"title":"Remark.","type":"string"}}},"TemplatePatternResponse":{"type":"object","properties":{"patternRequest":{"title":"Map of patterns configuration using with template.","type":"object","additionalProperties":{"$ref":"#/components/schemas/TemplateRegexConfiguration"}},"id":{"title":"Created pattern id.","type":"string"}}},"TemplateRegexConfiguration":{"type":"object","properties":{"regex":{"type":"string"},"ignoreKeys":{"type":"array","items":{"type":"string"}}}},"TemplateFullResponse":{"type":"object","properties":{"id":{"title":"Template ID.","type":"string"},"group":{"title":"Template generate group.","type":"string","example":"pdf"},"title":{"title":"Unique template name.","type":"string","example":"Template Name"},"code":{"title":"Unique template code.","type":"string","example":"templateCode"},"description":{"title":"Template description.","type":"string","example":"This is an example template."},"fileName":{"title":"Template upload file name.","type":"string"},"content":{"title":"Template content.","type":"string","example":"This is an example template."},"context":{"title":"Template context id.","type":"string","example":"en"},"label":{"title":"Label names list.","type":"string","description":"Label names which will be attached to the generated PDF assets; split by ,","example":"label_name1, label_name2"},"meta":{"title":"PDF Metadata configuration.","type":"object","additionalProperties":{"title":"PDF Metadata configuration.","type":"string","description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":"{\"filename\":\"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]\"}"},"description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":{"filename":"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]"}},"services":{"title":"Services list.","type":"string","description":"Service options which will be used in the template content; split by ,. See more: https://confluence.bluestonepim.com:9443/display/WOI/How+Bluestone+PDF+works#HowBluestonePDFworks-PDFserviceoptions","example":"mediabank, pim-category, pim-attribute, pdf-keepsingleversion, pim-attribute-number"},"modifiedAt":{"title":"Latest modified template timestamp.","type":"string"},"modifiedBy":{"title":"Latest modified template user.","type":"string"},"createdAt":{"title":"Created template timestamp.","type":"string"},"createdBy":{"title":"Created template user.","type":"string"},"defaultTemplate":{"title":"A flag if this template is default template.","type":"boolean","example":true}}},"CopyTemplateRequest":{"required":["title"],"type":"object","properties":{"title":{"title":"Unique template name.","type":"string","example":"Template Name"},"includeOptions":{"title":"A flag if include service options to the copied template.","type":"boolean","example":true},"includeHistory":{"title":"A flag if include template versions to the copied template.","type":"boolean","example":false}}},"TemplateRequest":{"required":["group","title"],"type":"object","properties":{"group":{"title":"Template generate group.","type":"string","example":"pdf"},"title":{"title":"Unique template name.","type":"string","example":"Template Name"},"code":{"title":"Unique template code.","type":"string","example":"templateCode"},"description":{"title":"Template description.","type":"string","example":"This is an example template."},"label":{"title":"Label names list.","type":"string","description":"Label names which will be attached to the generated PDF assets; split by ,","example":"label_name1, label_name2"},"meta":{"title":"PDF Metadata configuration.","type":"object","additionalProperties":{"title":"PDF Metadata configuration.","type":"string","description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":"{\"filename\":\"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]\"}"},"description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":{"filename":"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]"}},"content":{"title":"Template content.","type":"string","example":"This is an example template."},"services":{"title":"Services list.","type":"string","description":"Service options which will be used in the template content; split by ,. See more: https://confluence.bluestonepim.com:9443/display/WOI/How+Bluestone+PDF+works#HowBluestonePDFworks-PDFserviceoptions","example":"mediabank, pim-category, pim-attribute, pdf-keepsingleversion, pim-attribute-number"},"defaultTemplate":{"title":"A flag if this template is default template.","type":"boolean","example":true}}},"ListTemplateResponse":{"type":"object","properties":{"total":{"title":"Total number of items.","type":"integer","format":"int64"},"data":{"title":"List of items.","type":"array","items":{"$ref":"#/components/schemas/TemplateFullResponse"}}}},"UpdateTemplateRequest":{"type":"object","properties":{"title":{"title":"Unique template name.","type":"string","example":"Template Name"},"group":{"title":"Template generate group.","type":"string","example":"pdf"},"code":{"title":"Unique template code.","type":"string","example":"templateCode"},"description":{"title":"Template description.","type":"string","example":"This is an example template."},"label":{"title":"Label names list.","type":"string","description":"Label names which will be attached to the generated PDF assets; split by ,","example":"label_name1, label_name2"},"meta":{"title":"PDF Metadata configuration.","type":"object","additionalProperties":{"title":"PDF Metadata configuration.","type":"string","description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":"{\"filename\":\"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]\"}"},"description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":{"filename":"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]"}},"content":{"title":"Template content.","type":"string","example":"This is an example template."},"services":{"title":"Services list.","type":"string","description":"Service options which will be used in the template content; split by ,. See more: https://confluence.bluestonepim.com:9443/display/WOI/How+Bluestone+PDF+works#HowBluestonePDFworks-PDFserviceoptions","example":"mediabank, pim-category, pim-attribute, pdf-keepsingleversion, pim-attribute-number"},"defaultTemplate":{"title":"A flag if this template is default template.","type":"boolean","example":true}}},"ListTemplateVersionResponse":{"type":"object","properties":{"total":{"title":"Total number of items.","type":"integer","format":"int64"},"data":{"title":"List of items.","type":"array","items":{"$ref":"#/components/schemas/TemplateVersionResponse"}}}},"TemplateVersionResponse":{"type":"object","properties":{"versionId":{"title":"Template version id.","type":"string"},"html":{"title":"Template html content.","type":"string"},"content":{"title":"Template content in each context.","type":"string"},"group":{"title":"Template group.","type":"string","example":"pdf"},"title":{"title":"Template title.","type":"string"},"code":{"title":"Template code.","type":"string"},"description":{"title":"Template description.","type":"string"},"fileName":{"title":"Template upload filename.","type":"string"},"context":{"title":"Context id.","type":"string"},"label":{"title":"Label names list.","type":"string","description":"Label names which will be attached to the generated PDF assets; split by ,","example":"label_name1, label_name2"},"meta":{"title":"PDF Metadata configuration.","type":"object","additionalProperties":{"title":"PDF Metadata configuration.","type":"string","description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":"{\"filename\":\"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]\"}"},"description":"Metadata configuration for the generated PDF assets. If not set, will use the default","example":{"filename":"Sample_[NUMBER]_[TEMPLATENAME]_[DATETIME]"}},"services":{"title":"Services list.","type":"string","description":"Service options which will be used in the template content; split by ,. See more: https://confluence.bluestonepim.com:9443/display/WOI/How+Bluestone+PDF+works#HowBluestonePDFworks-PDFserviceoptions","example":"mediabank, pim-category, pim-attribute, pdf-keepsingleversion, pim-attribute-number"}}}},"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"}