Open in Claude Open in ChatGPT

Export Configuration

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Properties

The following properties are available:

Property Type Default Read-Only Description
artifactDependencies array No
artifactIncludes array No
endChangeset string No Only include data that is relevant to changesets at or before the specified changeset.
endDate object No Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports.
forceIncludes boolean No
includeACLs boolean true No Whether to include ACLs during export.
includeActivities boolean true No Whether to include Activities during export.
includeAttachments boolean true No Whether to include Attachments for Attachables during export.
includeBinaries boolean true No Whether to include Binaries for data stores during export.
includeTeams boolean true No Whether to include Teams during export.
startChangeset string No Only include data that is relevant to changesets at or beyond the specified changeset.
startDate object No Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports.

Schema


{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  },
  "id": "export"
}