DocumentList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-document-list-schema.json",
  "title": "DocumentList",
  "description": "A container for documents and related settings, such as supported documentTypes and publishing. \nA documentList belongs to a Mozu context, denoted by the documentList scopyeType and scopeId fields. \nExample: documentList A belongs to catalog 123, denoted by the documentList scopeType value of catalog and scopeId value of 123.\nA documentList can only be accessed if the API context is inclusive of the documentList's scope.\nExample: documentList A belongs to catalog 123. An API call with an API context of catalog 123 will be able to address documentList A.\nExample: site 456 uses catalog 123. An API call with an API context of site 456 will be able to address documentList A.\nExample: masterCatalog 789 is the parent of catalog 123. An API call with an API context of masterCatalog 789 will NOT be able to address documentList A.\nDocuments can be created, queried, managed and published from within a documentList. A documentList may be directly created, or indirectly created from a documentListType.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-content-openapi.yml#/components/schemas/DocumentList",
  "properties": {
    "documentListType": {
      "description": "The full name of the documentListType (name@namespace) that underlies the documentList. This value is only populated when the Mozu platform creates a documentList from a documentListType.\nA documentList that is directly created cannot specify a documentListType. This field is therefore read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "documentTypes": {
      "description": "An array of the full names (name@namespace) of the documentTypes supported by the documentList. A document in the documentList must belong to one of these documentTypes.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType. DocumentTypes can be added/removed to the documentList, even when\nbased on a documentListType. Existing documents that belong to a documentType removed from the documentList will not be removed.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "enableActiveDateRanges": {
      "description": "Determines if the documentList has ActiveDateRanges turned on or off. If the documentList has a supportsActiveDateRanges value of true, then the enableActiveDateRanges value will be honored.\nIf enableActiveDateRanges is true, then a document will only be returned if the request is made within the time frame the document has been set to be 'active'.\nIf enableActiveDateRanges is false, then the properties can be set but will not be honored.\nIf enableActiveDateRanges is true, then updating it to false will immediately start honoring the previously-set date range.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "enablePublishing": {
      "description": "Determines if the documentList has publishing turned on or off. If the documentList has a supportsPublishing value of true, then the enablePublishing value will be honored.\nIf enablePublishing is true, then a document draft will be created for a document create or update operation. A document must then be published to become \"active\".\nIf enablePublish is false, then all document changes are immediately \"active\".\nIf enablePublish is true, then updating it to false will immediately publish all draft changes.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "listFQN": {
      "description": "The unique identifier of the documentList, represented by name@namespace. The listFQN must be provided when creating the documentList, or the name and namespace fields must be provided.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType.",
      "type": [
        "string",
        "null"
      ]
    },
    "metadata": {
      "description": "Allows arbitrary data to be stored on the documentList.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.",
      "nullable": true
    },
    "name": {
      "description": "The name component of the listFQN, name@namespace. The name must be unique within the namespace component and cannot be updated.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType.",
      "type": [
        "string",
        "null"
      ]
    },
    "namespace": {
      "description": "The namespace component of the listFQN, name@namespace. The issued dev account namespace must be used unless elevated privileges allow a blank namespace to be used. The namespace cannot be updated.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType.",
      "type": [
        "string",
        "null"
      ]
    },
    "scopeId": {
      "description": "Used in conjunction with the scopeType field to determine the exact context within which the documentList resides.\nExample: A documentList with a scopeId of 5 and scopeType of masterCatalog belongs to masterCatalog 5.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType. This value is read-only after the documentList is created.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "scopeType": {
      "description": "The context level the documentList resides in. Valid values are \"tenant\", \"masterCatalog\", \"catalog\" and \"site\". This field is used in conjunction with the scopeId field\nto determine the exact context within which this documentList resides. This field is read-only after insert.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType. This value is read-only after the documentList is created.",
      "type": [
        "string",
        "null"
      ]
    },
    "security": {
      "description": "tbd",
      "type": [
        "string",
        "null"
      ]
    },
    "supportsActiveDateRanges": {
      "description": "Determines if the documentList will support ranges of dates that documents are considered 'active'. \nThis field defaults to false and cannot be updated.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportsPublishing": {
      "description": "Determines if the documentList will support drafting and publishing documents. \nThis field defaults to false and cannot be updated.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "usages": {
      "description": "An array of strings that describes to the Mozu platform the manner(s) in which a documentList can be used. The following values are valid:\nentitymanager -- the documentList should be visible in the Admin Content/Entities UI, which allows admin users to create, manage and publish documents within the documentList.\nsitebuilder -- the documentList should be visible in Site Builder. A documentList will display in the Site Builder Navigation Content List node, which supports document creation, management and web cms integration.\nIf the documentList is based on a documentListType, then this value will be derived from the documentListType. Usages can be added or removed from the documentList, even when the documentList derives from a\ndocumentListType.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "views": {
      "description": "An array of one or more views, which each allow GET access to a projection of fields from the documents in the given documentList. \nIf the documentList is based on a documentListType, then this value will be derived from the documentListType. Views can be added/removed to the documentList, even when\nthe documentList derives from a documentListType.",
      "items": {
        "$ref": "#/$defs/View"
      },
      "type": [
        "array",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "View": {
      "description": "A view provides GET access to documents within the documentList the view belongs to. The view can designate which document fields are returned (projection) and\na security model for providing GET access independent of the documentList's security model.",
      "properties": {
        "fields": {
          "description": "Designation of which document fields are returned (projection) when GETing documents from the view.",
          "items": {
            "$ref": "#/$defs/ViewField"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "filter": {
          "description": "Filter criteria to apply automatically when documents from this view are accessed, using the standard Mozu filter syntax. Only documents matching the filter criteria will be returned. \nAny filter provided by an operation is combined with the view filter.",
          "type": [
            "string",
            "null"
          ]
        },
        "includeInactiveMode": {
          "description": "If view documents are requested with includeInactive=true, then this controls which documents return. If includeInactive is not provided or set to false, then only active documents return.\nIf not set, or set to \"all\", then all documents return.\nIf set to \"active\", then only documents within the active date range and documents with no active date range are returned.\nIf set to \"scheduled\", then only documents with an active date range in the future are returned.\nIf set to \"activeOrScheduled\", then only documents that are active or documents with an active date range in the future are returned.\nIf set to \"ended\", then only documents with an active date range in the past are returned.",
          "type": [
            "string",
            "null"
          ]
        },
        "isAdminDefault": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "isVisibleInStorefront": {
          "description": "The isVisibleInStorefront field indicates whether documents in the view can be accessed from the Mozu storefront application. If true, the storefront application and storefront client application (javascript tier) \ncan GET documents from the view.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "metadata": {
          "description": "The metadata field allows arbitrary data to be stored on the view.",
          "nullable": true
        },
        "name": {
          "description": "A view is addressed via its name, which is unique within the documentList or documentListType in which it is defined.",
          "type": [
            "string",
            "null"
          ]
        },
        "usages": {
          "description": "tbd",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "ViewField": {
      "description": "The projection of an individual field in a view.",
      "properties": {
        "name": {
          "description": "The name of the field projected into the view document, meaning the name given to the target field after it is projected.\nThe name must be unique within the list of viewFields provided in the view.",
          "type": [
            "string",
            "null"
          ]
        },
        "target": {
          "description": "Specifies the document field to project. First-class fields will be returned on the document, but can be projected into the view properties. \nValid first-class fields include name, id, documentTypeFqn, listFqn and publishState. Dynamic fields within the properties field can be projected by prefixing the target string with \"properties.\"\nExample: \"properties.property1\". If a property is an object, then dot notation can be used to walk to particular subelements. Example: \"properties.property1.subProperty1\"\nIndividual array elements can be selected as well. Example: \"properties.property1.subProperty1.subSubArray[2].propertyOnArrayItem\"\nAny target miss will result in a null value returning for the projected field.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    }
  }
}