{"openapi":"3.0.1","info":{"title":"Content Batch Import API","description":"The Content Batch Import API enables developers to import large amounts of content into a Bloomreach project.\n\nAll operations are performed within the context of a developer project, and all writes are performed on the unpublished variant of a page or document associated with the project. This also provides an important benefit of being able to reject a batch as a whole in a single operation by deleting the corresponding project before merging.\n\n### How it works\n\nThe batch import works by sending a [JSON lines file](https://jsonlines.org/). The response to a batch operation is a job identifier which the caller can use to poll for the operation status.\n- When the operation is complete, the caller can obtain a report of the operation containing all successful and failed items.\n- In case of failed items, the API takes care to clean up as much as possible (e.g. delete or revert unfinished/corrupted documents) but it is also possible to easily clean up via the Projects perspective in Bloomreach Content UI.\n\n### Advantages\nAdvantages of using the Batch Import:\n- It takes care of references between documents, that otherwise the client needs to cater for (import documents in proper order)\n- It allows them to focus on the export from the legacy system, and using one file instead of many makes the process much easier\n- It is much more performing: it dramatically removes the overhead of making separate API requests (per document)","version":"Beta"},"externalDocs":{"description":"See official Bloomreach documentation","url":"https://documentation.bloomreach.com/content/reference/content-type-management-api"},"servers":[{"url":"https://developers.bloomreach.io/management/content-import/v1"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Content Import Batch Operations","externalDocs":{"description":"See","url":"https://documentation.bloomreach.com/content/reference/content-type-management-api"}}],"paths":{"/operations/{operation_id}":{"get":{"tags":["Content Import Batch Operations"],"summary":"Get operation details","description":"Get the details of an operation. Useful to keep track of all the batch requests.","operationId":"getOperationStatus_1","parameters":[{"name":"operation_id","in":"path","description":"Operation ID","required":true,"schema":{"type":"string"},"example":"0f68c6d9-cfee-49ac-9cff-6d82d34ee704"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Operation status example response":{"description":"Show details about a specific operation","value":{"operationId":"0f68c6d9-cfee-49ac-9cff-6d82d34ee704","projectId":"vI8Xo","status":"COMPLETED","readCount":6,"writeCount":5,"skipCount":1,"startTime":"2022-03-21T10:47:00.448+00:00","endTime":"2022-03-21T10:47:08.632+00:00","errorLog":[{"path":"pages/home","error":"Item not found; nested exception is javax.jcr.ItemNotFoundException: Component definition 'hst:components/sample/single-banner-carouselZ' not found"}]}}}}}},"403":{"description":"Forbidden"}}}},"/project/{project_id}":{"post":{"tags":["Content Import Batch Operations"],"summary":"Create content (documents and pages) in a specific project.","description":"Create content (documents and pages) in a specific project.\n### Automatic creation of folders\nBoth document and page endpoints require a path provided in the URL. The path corresponds to a folder structure in the content tree which if not existing already, it will be created. The created folders are the simplest folders you can create in CMS, meaning no \"allowed content\" is configured, neither translation links, nor any particular sorting.\n### Document linking\nDocuments and pages may contain links to other documents that do not exist yet, or exist as a part of the same import payload. They can even reference each other. To support this, the batch import operation is split into two steps:\n- Content Import: during this step, documents containing references to non existing links are being saved with a placeholder UUID rather than a real link (which does not exist yet).\n- Linking: update all existing document references with a reference, otherwise report an error. Invalid link references remain, so the developers have a choice of either manually fixing the links through CMS, fix the payload and rerun the import operation, or drop the whole branch and start over again.","operationId":"importFile_1","parameters":[{"name":"project_id","in":"path","description":"specifies the project content is added to","required":true,"schema":{"type":"string"},"example":"vIUy9"}],"requestBody":{"description":"The payload for this operation is a json lines file that conforms to the [json lines specification](https://jsonlines.org/), and the contents are a mix of BatchDocument, BatchPage, BatchResourceBundle, BatchFolder and XPageBatchFolder entities, see [schema](https://documentation.bloomreach.com/content/openapi/62cf0c7d7db203003de12ac0)","content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"},"examples":{"Example with 2 documents and 1 page":{"description":"This example shows the payload for 2 documents and 1 page","value":"{\"type\":\"document\",\"contentType\":\"brxsaas:banner\",\"fields\":[{\"name\":\"title\",\"value\":[\"Our team is ready for your next product\"]},{\"name\":\"content\",\"value\":[\"<p>example content</p>\"]},{\"name\":\"image\",\"value\":[\"\\/\"]},{\"name\":\"cta\",\"value\":[\"Start your next project\"]},{\"name\":\"link\",\"value\":[\"\\/content\\/documents\\/brxsaas\\/pages\\/products\\/all\"]}],\"name\":\"next-project11\",\"displayName\":\"Next Project11\",\"path\":\"\\/content\\/documents\\/brxsaas\\/banners\\/next-project11\"}\n{\"type\":\"document\",\"contentType\":\"brxsaas:banner\",\"fields\":[{\"name\":\"title\",\"value\":[\"Brand 1\"]},{\"name\":\"content\",\"value\":[\"<p>Sample content</p>\"]},{\"name\":\"image\",\"value\":[\"\\/content\\/gallery\\/brxsaas\\/banners\\/brand-1.jpg\"]},{\"name\":\"cta\",\"value\":[]},{\"name\":\"link\",\"value\":[\"\\/content\\/documents\\/brxsaas\\/pages\\/products\\/all\"]}],\"name\":\"brand-111\",\"displayName\":\"Brand 111\",\"path\":\"\\/content\\/documents\\/brxsaas\\/banners\\/brand-111\"}\n{\"type\":\"page\", \"relativePath\":\"pages/home\", \"channelId\":\"brxsaas\",\"name\":\"home\",\"displayName\":\"Home\",\"layout\":\"two-column\",\"document\":{\"contentType\":\"brxsaas:content\",\"fields\":[{\"name\":\"title\",\"value\":[\"My page\"]},{\"name\":\"introduction\",\"value\":[\"Sample introduction\"]},{\"name\":\"content\",\"value\":[\"Example page content\"]},{\"name\":\"image\",\"value\":[\"\\/\"]},{\"name\":\"date\",\"value\":[]}]},\"containers\":[{\"path\":\"top\",\"components\":[{\"componentDefinition\":\"sample\\/single-banner-carousel\",\"componentConfigurations\":[{\"id\":\"DEFAULT\",\"content\":null,\"parameters\":[{\"name\":\"alignment\",\"value\":\"center\"},{\"name\":\"document1\",\"value\":\"banners\\/safe-workspace-1\"},{\"name\":\"document2\",\"value\":\"banners\\/safe-workspace-2\"},{\"name\":\"interval\",\"value\":\"10000\"}]}]}]},{\"path\":\"main\",\"components\":[{\"componentDefinition\":\"sample\\/titleandtext\",\"componentConfigurations\":[{\"id\":\"DEFAULT\",\"content\":{\"contentType\":\"titleandtext\",\"fields\":[{\"name\":\"title\",\"value\":[\"Welcome to brX ContentX\"]},{\"name\":\"text\",\"value\":[\"Welcome to the Bloomreach Sample Front-end Application for the brX Content.\"]}]},\"parameters\":[{\"name\":\"titlesize\",\"value\":\"H3\"},{\"name\":\"textalignment\",\"value\":\"left\"},{\"name\":\"style\",\"value\":\"style1\"}]}]},{\"componentDefinition\":\"sample\\/titleandtext\",\"componentConfigurations\":[{\"id\":\"DEFAULT\",\"content\":{\"contentType\":\"titleandtext\",\"fields\":[{\"name\":\"title\",\"value\":[\"\"]},{\"name\":\"text\",\"value\":[\"We have tried to keep it as clean, effective and simple as possible\"]}]},\"parameters\":[{\"name\":\"titlesize\",\"value\":\"H3\"},{\"name\":\"textalignment\",\"value\":\"left\"},{\"name\":\"style\",\"value\":\"style1\"}]}]},{\"componentDefinition\":\"sample\\/category-highlight\",\"componentConfigurations\":[{\"id\":\"DEFAULT\",\"content\":{\"contentType\":\"CategoryHighlight\",\"fields\":[{\"name\":\"title\",\"value\":[\"Highlight categories\"]},{\"name\":\"connectorid\",\"value\":[\"brsm\"]},{\"name\":\"CommerceCategoryCompound\",\"value\":[{\"fields\":{\"categoryid\":[\"PNB160400000000\"]}},{\"fields\":{\"categoryid\":[\"PNB160402010000\"]}},{\"fields\":{\"categoryid\":[\"PNB160401010000\"]}},{\"fields\":{\"categoryid\":[\"PNB250800000000\"]}}]}]},\"parameters\":[]}]}]}]}"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Example response after import":{"description":"In this example the response can be seen after an import request is successfully submitted","value":{"operationId":"0f68c6d9-cfee-49ac-9cff-6d82d34ee704","projectId":"vI8Xo","status":"STARTING","readCount":0,"writeCount":0,"skipCount":0,"startTime":null,"endTime":null,"errorLog":[]}}}}}},"403":{"description":"Forbidden"}}}},"/operations":{"get":{"tags":["Content Import Batch Operations"],"summary":"List all operations","description":"Returns the list of all operations.","operationId":"listAllOperations_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"A response with 2 operations":{"description":"In this example response there are two operations available","value":["0f68c6d9-cfee-49ac-9cff-6d82d34ee704","bc90666b-10bb-4838-80d6-a59f59e9b08c"]}}}}},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"ErrorLog":{"type":"object","properties":{"path":{"type":"string"},"error":{"type":"string"}},"description":"A log of errors of an operation"},"OperationStatus":{"required":["endTime","errorLog","exitMessage","operationId","projectId","readCount","skipCount","startTime","status","writeCount"],"type":"object","properties":{"operationId":{"type":"string","description":"Operation ID"},"projectId":{"type":"string","description":"Project ID"},"status":{"type":"string","description":"Operation Status","enum":["COMPLETED","STARTING","STARTED","STOPPING","STOPPED","FAILED","ABANDONED"]},"exitMessage":{"type":"string","description":"Exit Message in case of operation failure"},"readCount":{"type":"integer","description":"Number of records in input payload","format":"int32"},"writeCount":{"type":"integer","description":"Written items","format":"int32"},"skipCount":{"type":"integer","description":"Skipped items","format":"int32"},"startTime":{"type":"string","description":"Operation start time","format":"date-time"},"endTime":{"type":"string","description":"Operation end time","format":"date-time"},"errorLog":{"type":"array","description":"Operation start time","items":{"$ref":"#/components/schemas/ErrorLog"}}},"description":"An entity containing information about an operation"},"BatchDocument":{"required":["contentType","displayName","fields","name","path","type"],"type":"object","properties":{"contentType":{"type":"string","description":"the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content"},"fields":{"type":"array","description":"fields of this document. A document field represents an attribute of the document, as specified in the document's content type. See [Content type fields](https://documentation.bloomreach.com/content/reference/content-type-fields) and [General concepts](https://documentation.bloomreach.com/content/docs/content-model-concepts)","items":{"$ref":"#/components/schemas/DocumentField"}},"name":{"pattern":"^[a-z0-9-._]*","type":"string","description":"identifying name of this document. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path."},"displayName":{"type":"string","description":"name of this document. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the document is new, b. the document only exists in the project specified in this operation"},"path":{"type":"string","description":"absolute path of this document in the content repository"},"system":{"$ref":"#/components/schemas/System"},"type":{"type":"string","description":"the type of this batch entity"}},"description":"A combination of a 'Document', and a 'BatchEntity', therefore containing all the fields of aDocument, and a discriminator called 'type', which must be 'document'"},"DocumentField":{"required":["name","value"],"type":"object","properties":{"name":{"pattern":"^[A-Za-z0-9_]*","type":"string","description":"identifying name of this field. Value needs to correspond to the name of a field definition in the document's content type"},"value":{"type":"array","description":"value of a field. As fields can be multiple, this attribute is an array of values","items":{"$ref":"#/components/schemas/FieldValue"}}},"description":"A document field represents an attribute of the document, as specified in the document's content type. See [Content type fields](https://documentation.bloomreach.com/content/reference/content-type-fields) and [General concepts](https://documentation.bloomreach.com/content/docs/content-model-concepts)"},"EmbeddedResourceFieldValue":{"required":["binarydata","filename","mimeType"],"type":"object","properties":{"filename":{"type":"string","description":"the name of the file that is used as default value"},"binarydata":{"type":"string","description":"the binary data of the file that is used as default value. This data has to be encoded using base64"},"mimeType":{"type":"string","description":"the mimeType of the file to be uploaded"}},"description":"See [EmbeddedResource](https://documentation.bloomreach.com/content/reference/content-type-fields#embeddedresource)"},"FieldGroupFieldValue":{"required":["fields"],"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"array","description":"fields from FieldGroup or SelectableFieldGroup","items":{"$ref":"#/components/schemas/FieldValue"}},"description":"fields from FieldGroup or SelectableFieldGroup"}},"description":"See [FieldGroup](https://documentation.bloomreach.com/content/reference/content-type-fields#fieldgroup)"},"FieldValue":{"type":"object","description":"Value of a field","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"number","format":"double"},{"$ref":"#/components/schemas/EmbeddedResourceFieldValue"},{"$ref":"#/components/schemas/FieldGroupFieldValue"},{"$ref":"#/components/schemas/SelectableFieldGroupFieldValue"}]},"SelectableFieldGroupFieldValue":{"required":["fieldGroupType","fields"],"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"array","description":"fields from FieldGroup or SelectableFieldGroup","items":{"$ref":"#/components/schemas/FieldValue"}},"description":"fields from FieldGroup or SelectableFieldGroup"},"fieldGroupType":{"type":"string","description":"the name of the fieldgroup type this default value is provided for. Unless the field group type belongs to the default group ('brxsaas'), the name must be prefixed with the group name and the colon character, e.g. 'mygroup:myfieldgrouptype'"}},"description":"See [Selectable FieldGroup](https://documentation.bloomreach.com/content/reference/content-type-fields#selectable-fieldgroup)"},"System":{"type":"object","properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"description":"system properties","readOnly":true},"BaseDocument":{"required":["contentType","fields"],"type":"object","properties":{"contentType":{"type":"string","description":"the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content"},"fields":{"type":"array","description":"fields of this document. A document field represents an attribute of the document, as specified in the document's content type. See [Content type fields](https://documentation.bloomreach.com/content/reference/content-type-fields) and [General concepts](https://documentation.bloomreach.com/content/docs/content-model-concepts)","items":{"$ref":"#/components/schemas/DocumentField"}}},"description":"The internal data of a document, including content type and fields"},"BatchPage":{"required":["channelId","displayName","document","layout","name","relativePath","type"],"type":"object","properties":{"name":{"pattern":"^[a-z0-9-._]*","type":"string","description":"identifying name of this page. Only valid characters are lowercase alphanumeric, dot, dash and underscore. This value appears in URLs"},"displayName":{"type":"string","description":"name of this page. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the page is new, b. the page only exists in the project specified in this operation"},"layout":{"type":"string","description":"the page template"},"document":{"$ref":"#/components/schemas/BaseDocument"},"containers":{"type":"array","description":"array of containers of this page","items":{"$ref":"#/components/schemas/PageContainer"}},"channelId":{"pattern":"^[A-Za-z0-9_-]*","type":"string","description":"Channel ID"},"relativePath":{"type":"string","description":"relative path of this page to the channel's content root"},"system":{"$ref":"#/components/schemas/System"},"type":{"type":"string","description":"the type of this batch entity"}},"description":"A combination of a 'Page', and a 'BatchEntity', therefore containing all the fields of aPage, and a discriminator called 'type', which must be 'page'. Additionally, a BatchPage requires a channel id and a relative path (relative to the channel's content root) to be provided"},"PageComponent":{"type":"object","properties":{"componentDefinition":{"type":"string"},"componentConfigurations":{"type":"array","description":"The list of component configurations for this component","items":{"$ref":"#/components/schemas/PageComponentConfiguration"}}},"description":"array of components used in this container"},"PageComponentConfiguration":{"type":"object","properties":{"id":{"type":"string","description":"The id of this configuration. The id of the default variant of a component should be DEFAULT, for the rest of the variants, the variant id is created in the format of campaign_id:campaign_segment_id or segmentation_id:segment_id, See [Segmentation & Campaigns](https://documentation.bloomreach.com/content/docs/content-audiences)"},"content":{"$ref":"#/components/schemas/BaseDocument"},"parameters":{"type":"array","description":"The list of component parameters for this configuration","items":{"$ref":"#/components/schemas/StringParameter"}}},"description":"A configuration for a PageComponent"},"PageContainer":{"required":["path"],"type":"object","properties":{"path":{"type":"string","description":"path of the container"},"components":{"type":"array","description":"array of components used in this container","items":{"$ref":"#/components/schemas/PageComponent"}}},"description":"array of containers of this page"},"StringParameter":{"type":"object","properties":{"name":{"type":"string","description":"name of this parameter"},"value":{"type":"string","description":"value of this parameter"}},"description":"A pair of string name and value. See [Content types](https://documentation.bloomreach.com/content/reference/content-type-management-api/content-types) and [General concepts](https://documentation.bloomreach.com/content/docs/content-model-concepts)"},"BatchResourceBundle":{"required":["displayName","id","keys","name","path","type","valueSets"],"type":"object","properties":{"name":{"pattern":"^[a-z0-9-._]*","type":"string","description":"identifying name of this resource bundle. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path."},"displayName":{"type":"string","description":"name of this resource bundle. Used in labels in the CMS UI"},"id":{"pattern":"^[a-zA-Z0-9-._]*","type":"string","description":"id of the resource bundle which is expected to be unique in content application. The resource bundle is assigned with this unique id."},"path":{"type":"string","description":"absolute path of this resource bundle in the content repository"},"keys":{"type":"array","description":"keys of the resource bundle. The messages in a resource bundle are fetched by key values.","items":{"$ref":"#/components/schemas/ResouceBundleKey"}},"valueSets":{"type":"array","description":"value sets of the resource bundle. Typically, a value set represents all values for a specific locale inside the resource bundle.","items":{"$ref":"#/components/schemas/ResourceBundleValueSet"}},"system":{"$ref":"#/components/schemas/System"},"type":{"type":"string","description":"the type of this batch entity"}},"description":"A combination of a 'ResourceBundle', and a 'BatchEntity', therefore containing all the fields of aResourceBundle, and a discriminator called 'type', which must be 'resourcebundle'"},"ResouceBundleKey":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[a-zA-Z0-9-._]*","type":"string","description":"identifying the key name that is used to retrieve a localized message from the resource bundle, unique within the resource bundle. Valid characters are only lower/uppercase letters, numbers, and '-' '.' '_'"},"description":{"type":"string","description":"description of this resource bundle key"}},"description":"It defines a key in a resource bundle which is used to retrieve a localized message from the resource bundle"},"ResouceBundleMessage":{"required":["key"],"type":"object","properties":{"key":{"pattern":"^[a-zA-Z0-9-._]*","type":"string","description":"identifying key of the message. The keys that are defined as 'ResouceBundleKey' can be set here. Only valid characters are lower/uppercase letters, numbers, and '-' '.' '_'"},"value":{"type":"string","description":"value of this resource bundle message"}},"description":"a key-value pair that defines the message for a specific key in a value set."},"ResourceBundleValueSet":{"required":["name"],"type":"object","properties":{"messages":{"type":"array","description":"messages in the value set","items":{"$ref":"#/components/schemas/ResouceBundleMessage"}},"name":{"pattern":"^[a-zA-Z0-9-._]*","type":"string","description":"name of the message value set. Expects a string value. Default messages are defined in a specific value set named 'DEFAULT'.For locale specicific messages, locale names are defined as value set name such as 'nl' (Dutch) or 'en_US' (American English"}},"description":"A value set represents all messages for a specific locale(mostly) inside the resource bundle.Default messages are defined in a specific value set named 'DEFAULT'."},"BatchFolder":{"required":["path","type"],"type":"object","properties":{"path":{"type":"string","description":"Folder path. An absolute path of this document in the content repository"},"displayName":{"type":"string","description":"Display name of the of the folder. Used in labels in the CMS UI."},"locale":{"type":"string","description":"Folder locale."},"restricted":{"type":"boolean","description":"Indicates whether this folder is restricted. Setting this to false clears any readUsers and writeUsers entries automatically"},"allowedDocumentTypes":{"type":"array","description":"List of allowed document types. Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.","items":{"type":"string","description":"List of allowed document types"}},"allowedFolderTypes":{"type":"array","items":{"type":"string"}},"readUsers":{"type":"array","description":"List of users with read access in this restricted folder","items":{"type":"string","description":"A username of a CMS user"}},"writeUsers":{"type":"array","description":"List of users with write access in this restricted folder","items":{"type":"string","description":"A username of a CMS user"}},"documents":{"type":"array","description":"List of documents stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/DocumentSummary"}},"resourceBundles":{"type":"array","description":"List of resource bundles stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/DocumentSummary"}},"folders":{"type":"array","description":"List of nested folders within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/Folder"}},"type":{"type":"string","description":"the type of this batch entity"}},"description":"A combination of a 'Folder', and a 'BatchEntity', therefore containing all the fields of a Folder, and a discriminator called 'type', which must be 'folder'"},"DocumentSummary":{"type":"object","properties":{"name":{"type":"string","description":"identifying name of this resource. This value appears in URLs."},"displayName":{"type":"string","description":"name of this resource. Used in labels in the CMS UI and in Delivery API."},"contentType":{"type":"string","description":"the content type of the resource (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content"},"path":{"type":"string","description":"absolute path of this resource in the content repository"},"branches":{"uniqueItems":true,"type":"array","description":"the list of branches where this resource exists.","items":{"type":"string","description":"the list of branches where this resource exists."}}},"description":"A representation of a document used from within a folder object that exposes its most relevant metadata","readOnly":true},"Folder":{"required":["path","type"],"type":"object","properties":{"type":{"type":"string"}},"description":"A Folder is a container item that can contain other folders or items","readOnly":true,"discriminator":{"propertyName":"type","mapping":{"folder":"#/components/schemas/Folder","pageFolder":"#/components/schemas/PageFolder"}},"oneOf":[{"$ref":"#/components/schemas/Folder"},{"$ref":"#/components/schemas/PageFolder"}]},"PageFolder":{"required":["channel","path"],"type":"object","description":"A special type of folder that can hold Experience pages","allOf":[{"$ref":"#/components/schemas/Folder"},{"type":"object","properties":{"channel":{"type":"string","description":"identifying name of the channel this experience folder is connected to."},"pages":{"type":"array","description":"List of pages stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/PageSummary"}}}}]},"PageSummary":{"type":"object","properties":{"name":{"type":"string","description":"identifying name of this resource. This value appears in URLs."},"displayName":{"type":"string","description":"name of this resource. Used in labels in the CMS UI and in Delivery API."},"contentType":{"type":"string","description":"the content type of the resource (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content"},"path":{"type":"string","description":"absolute path of this resource in the content repository"},"branches":{"uniqueItems":true,"type":"array","description":"the list of branches where this resource exists.","items":{"type":"string","description":"the list of branches where this resource exists."}},"channel":{"type":"string","description":"identifying name of the channel this page belongs to."},"relativePagePath":{"type":"string","description":"the relative path of this experience page with respect to the root content path of the channel"}},"description":"A representation of an experience page used from within a folder object that exposes its most relevant metadata","readOnly":true},"XPageBatchFolder":{"required":["channel","path","type"],"type":"object","properties":{"path":{"type":"string","description":"Folder path. An absolute path of this document in the content repository"},"displayName":{"type":"string","description":"Display name of the of the folder. Used in labels in the CMS UI."},"locale":{"type":"string","description":"Folder locale."},"restricted":{"type":"boolean","description":"Indicates whether this folder is restricted. Setting this to false clears any readUsers and writeUsers entries automatically"},"channel":{"type":"string","description":"identifying name of the channel this experience folder is connected to."},"allowedDocumentTypes":{"type":"array","description":"List of allowed document types. Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.","items":{"type":"string","description":"List of allowed document types"}},"allowedFolderTypes":{"type":"array","items":{"type":"string"}},"readUsers":{"type":"array","description":"List of users with read access in this restricted folder","items":{"type":"string","description":"A username of a CMS user"}},"writeUsers":{"type":"array","description":"List of users with write access in this restricted folder","items":{"type":"string","description":"A username of a CMS user"}},"documents":{"type":"array","description":"List of documents stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/DocumentSummary"}},"resourceBundles":{"type":"array","description":"List of resource bundles stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/DocumentSummary"}},"pages":{"type":"array","description":"List of pages stored within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/PageSummary"}},"folders":{"type":"array","description":"List of nested folders within this folder","readOnly":true,"items":{"$ref":"#/components/schemas/Folder"}},"type":{"type":"string","description":"the type of this batch entity"}},"description":"A combination of a 'XPageFolder', and a 'BatchEntity', therefore containing all the fields of aXPageFolder, and a discriminator called 'type', which must be 'pageFolder'"}},"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"x-auth-token","in":"header"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}